Get/add/remove channels from channel groups
This endpoint supports several operations:
Operation | Required attributes |
---|---|
Listing all channels for a channel group | sub_key , group , uuid |
Adding channels to a channel group / Creating a new channel group | sub_key , group , uuid , add |
Removing channels from a channel group | sub_key , group , uuid , remove |
Path Parameters |
---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. Example: sub-c-50264475-1902-558x-d213-7p19052012n2 |
group string — REQUIREDThe group for which we need the list of channels. Example: group1 |
Query Parameters |
---|
auth stringString which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Example: authKey / p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI |
uuid string — REQUIREDA UTF-8 encoded string of up to 64 characters used to identify the client. Example: myUniqueUserId |
add stringName of a channel to be added to the channel group. You may add mulitple channels using a comma seperator (ch1,ch2,ch3). Required to add channel to a channel group. Example: ch1 |
remove stringName of a channel to be removed from the channel group. You may add mulitple channels using a comma seperator (ch1,ch2,ch3). Required to remove channel from a channel group. Example: ch1 |
signature stringSignature used to verify that the request was signed with the secret key associated with the subscriber key. If Access Manager is enabled, either a valid authorization token or a signature are required. See Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 second offset from NTP. Required if |
Responses | |||||||
---|---|---|---|---|---|---|---|
200 OK
| |||||||
400 Bad Request
| |||||||
403 Channel Groups Multiplexing Flag Disabled Error
| |||||||
500 Channel Groups Storage Error
| |||||||
503 Channel Groups Account Configuration Error
|