# List Single Channel

API call format

GET /broker/channels/{<channel_guid>}           //Use token autorization
GET /broker/private/channels/{<channel_guid>}   //Use Api Key

Description

This call gets single channel details by given channel guid.

Precondition

  • Authorization token/Api key is needed.
  • Mandatory elements (should be specified):

Postcondition

  • On success response code should be 200
  • On success the details in JSON format of the requested video channel is returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/broker/channels/<channel_guid>    //use GET /broker/channels to find a specific guid
[Request] GET https://<base_api_url>/broker/private/channels/<channel_guid>    //use GET /broker/channels to find a specific guid
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
  "status": true,
  "data": [
    {
      "guid": "<channel_guid>",
      "name": "<channel_name>",
      "description": "<channel_description>",
      "type": "virtual",
      "active": 1,                                                      //flag if channel is active 
      "hasAds": 0,            
      "order": 2,                                                       //channel order in the GUI channel list
      "playbackUrl": "https://<server>/broker/play/<channel_guid>.m3u8"
    }
}