View channel information

Article Summary

Share feedback

Thanks for sharing your feedback!

Live Station provides an API to view the VOD channel’s details.

Requests

GET https://livestation.apigw.ntruss.com/api/v2/vod/channels/{channelId}

Request headers

Header name	Requirement status	Description
x-ncp-apigw-timestamp	YES	It indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds, and the request is considered invalid if the time difference from the API Gateway server is 5 minutes or longer `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	Value of access key ID issued in the 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)

Response

Field name	Type	Description	Remarks
channelName	String
channelId	String
instanceNo	String
channelStatus	String	CREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETED
createdTime	String
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	RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND	CDN status
cdn.serviceName	String	CDN Service Name	If NO_CDN, ""
cdn.cdnDomain	String	CDN Domain	If NO_CDN, ""
qualitySetId	Integer
qualitySetName	String
outputProtocol	String	Default set: HLS
alertOn	Boolean		if alertOn == true, alertOptions should be set
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 example

GET /api/v2/vod/channels/ls-20211122220557-mUv3r
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 example

{
  "content": {
    "channelId": "ls-20211122220557-mUv3r",
    "channelName": "myChannel",
    "instanceNo": 2043025,
    "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": 0,
    "createdTime": 1637586357000,
    "updatedTime": 1637679496000,
    "alertOn": false,
    "alertOptions": {
      "alertChangeStatus": false
    },
    "callbackEndpoint": "http://ey.1123.callback",
    "envType": "REAL",
    "type": "VOD",
    "drmEnabledYn": true,
    "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
    }
  }
}

Was this article helpful?

What's Next

Edit channel settings

Table of contents

Requests
Response
Examples