View channel list

Article Summary

Share feedback

Thanks for sharing your feedback!

Live Station provides an API to view a list of VOD channels.

Requests

GET https://livestation.apigw.ntruss.com/api/v2/vod/channels?pageNo={pageNo}&pageSizeNo={pageSizeNo}

Request parameters

Parameter name	Required	Type	Service limits	Description
pageNo	No	Integer	No restriction	Page index to view
pageSizeNo	No	Integer	1 ~ 100	Number of channels to include when viewing list For example, when 60 channels are created with pageSizeNo 30, the viewing of channel list is done in 30 channels per page

Request headers

Header name	Required	Description
x-ncp-apigw-timestamp	YES	Time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference compared to the API Gateway server is 5 minutes or longer `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	Access key ID value issued from NAVER Cloud Platform portal `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-region_code	YES	Region code (KR)

Responses

Field name	Type	Description	Note
channelName	String
channelId	String
instanceNo	String
channelStatus	String	CREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETED	VOD channels can only be suspended when the status is RESERVED or PUBLISHING
snapshot	Object
snapshotId	Integer
cdn	Object
cdn.cdnType	String	CDN_PLUS, GLOBAL_CDN, GLOBAL_EDGE
cdn.instanceNo	String		If NO_CDN, 0
cdn.profileId	Integer	Profile ID of Global Edge	If NO_CDN, 0
cdn.statusName	String	CDN status	RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND
cdn.serviceName	String	CDN Service Name	If NO_CDN, ""
cdn.cdnDomain	String	CDN Domain	If NO_CDN, ""
qualitySetId	Integer
qualitySetName	String
outputProtocol	String
alertOn	Boolean
alertOptions	Object
alertOptions.alertChangeStatus	Boolean
totalPublishSeconds	Integer
createdTime	Integer
updatedTime	Integer
envType	String	DEV, STAGE, REAL
type	String	VOD
callbackEndpoint	String
scheduleList	Array		Responds only if schedule exists
scheduleList.scheduleId	Integer
scheduleList.status	String
drmEnabledYn	Boolean	Whether to apply DRM Encryption settings
drm	Object	DRM Encryption settings using Live Station When setting DRM, FairPlay and Widevine/PlayReady DRM are supported
drm.siteId	String	Site id created through One Click Multi DRM product
drm.contentId	String	Unique ID of content where DRM Encryption is applied Used for DRM packaging. You can enter 3 to 100 characters using English letters, numbers, hyphens (-), and underscores (_).

Examples

Request examples

GET /api/v2/vod/channels
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR

Response examples

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Feb 2021 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": [
    {
      "channelId": "ls-20211122214005-DMOTD",
      "channelName": "myChannel1",
      "instanceNo": 2042924,
      "qualitySetId": 4,
      "qualitySetName": "720p-set",
      "outputProtocol": "HLS",
      "status": "READY",
      "cdn": {
        "instanceNo": "1541959",
        "serviceName": "cdn-ls-20201204112949-D7RTL",
        "statusName": "running",
        "cdnType": "CDN_PLUS",
        "cdnDomain": "mycdn.cdn.ntruss.com",
        
      },
      "totalPublishSeconds": 5405,
      "createdTime": 1637584805000,
      "updatedTime": 1637591709000,
      "alertOn": false,
      "recentPublishTime": 1637586303000,
      "alertOptions": {
        "alertChangeStatus": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "REAL",
      "type": "VOD",
      "drmEnabledYn": true,
      "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
      },
      "scheduleList": [
        {
          "scheduleId": 10049,
          "status": "FINISH"
        }
      ]
    },
    {
      "channelId": "ls-20211117184137-8rRjJ",
      "channelName": "myChannel2",
      "instanceNo": 2029554,
      "qualitySetId": 4,
      "qualitySetName": "720p-set",
      "outputProtocol": "HLS",
      "status": "READY",
      "cdn": {
        "instanceNo": "1541959",
        "serviceName": "cdn-ls-20201204112949-D7RTL",
        "statusName": "running",
        "cdnType": "CDN_PLUS",
        "cdnDomain": "mycdn.cdn.ntruss.com",
        
      },
      "totalPublishSeconds": 21604,
      "createdTime": 1637142098000,
      "updatedTime": 1637309411000,
      "alertOn": false,
      "recentPublishTime": 1637287806000,
      "alertOptions": {
        "alertChangeStatus": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "DEV",
      "type": "VOD",
      "drmEnabledYn": true,
      "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
      },
      "scheduleList": [
        {
          "scheduleId": 10019,
          "status": "FINISH"
        }
      ],
      "audioOnly": false
    }
  ],
  "total": 2
}

Was this article helpful?

What's Next

View channel information

Table of contents

Requests
Responses
Examples