version 8.3.8

Back | 

WsChannel

Returns channels

URL Format

/ws/ws_channel/api/{app_token}/mode/json/apiv/5?uuid={channel_uuid}&packageUUID={packageUUID}&start={start}&end={end}

Parameters

Name Req Type Description
app_token string Api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer Api version, only version 5 supported.
uuid string uuid of the channel
pacakgeUUID string Package uuid to get all the channels belonging to the given package
start int Will return a subset of available channels. Used primarily for pagination. Default is set to 0
end integer Will return a subset of available channels. Used primarily for pagination. Default is set to start+20

Request Headers

Name
Authorization: Bearer {usertoken}, clienttoken: {client uuid}

Possible Responses

  • 624 Channels Found
  • 649 No Channels Found
  • 102 Invalid app token

Example Response

{
  "response": {
    "success": {
      "code": 624,
      "message": "Channels Found",
      "details": "Total Count: 1"
    },
    "WsChannelResponse": {
      "channels": [
        {
          "class": "Channel",
          "id": 135,
          "channelGroup": 33,
          "title": "Jay's Channel Test",
          "description": "Test Channel ",
          "thumbnailURL": "http:\/\/EDGE_DOMAIN_URL\/thumbs\/aid\/2375148.jpg",
          "clientid": 277,
          "uuid": "xrbk5x36",
          "isActive": 1,
          "enablePlayerSideStitching": 1,
          "rtmpURL": "\/xrbk5x36\/aq0i39e8",
          "m3u8URL": "\/xrbk5x36\/aq0i39e8\/playlist.m3u8",
          "streamPackage": [
            
          ],
          "activeScheduleId": "219",
          "activeScheduleUUID": "aq0i39e8"
        }
      ],
      "totalCount": 1
    }
  }
}