deleteChannelMember - kewalsk/My-OpenPeriscope GitHub Wiki
DELETE https://channels.pscp.tv/v1/channels/{cid}/members/{uid}
The deleteChannelMember service removes one member of given {uid} from the channel of given {cid}. The channel must be accessible to the authorized user. The authorized user must be one of members of the {cid} channel if this channel is not restricted and must be the owner of channel if channel is restricted. CID is unique identification number of the channel and can be obtained from the list of channels.
Place | Name | Type | Description | Optional |
---|---|---|---|---|
@Header | Authorization | String | The authorization token got from authorizeToken | No |
@Path | CID | String | The unique identification number of the channel | No |
@Path | uid | String | The user id to be removed | No |
The HTTP response code on successful deletion is 200 OK and the body is empty object {}
.
HTTP Result | HTTP Message | Body message | Description |
---|---|---|---|
400 | Bad Request |
{"success":false,"msg":"Bad Request"}
|
The request has some improper arguments, for example token is wrong |
400 | Bad Request |
|
The response http error 400 without body means usually access problem, i.e the channel is restricted or user id is wrong |
401 | Unauthorized |
Token did not validate:token is expired
|
The authorization token is expired - get the new one |
401 | Unauthorized |
Requires authorization header
|
There is no Authorization header in request |
401 | Unauthorized |
Token did not validate:token contains an invalid number of segments
|
The authorization token is wrong |
405 | Method Not Allowed |
|
Wrong HTTP method was used, different than DELETE |
Sending request (set $token to the proper value first):
curl -X DELETE -H "Authorization: $token" https://channels.pscp.tv/v1/channels/1752882535103340571/members/***
Result:
{}