Get channel information
- Print
- PDF
Get channel information
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Live Station provides and API to get VOD channel details.
Request
GET https://livestation.apigw.ntruss.com/api/v2/vod/channels/{channelId}
Request headers
| Header name | Required | Description |
|---|---|---|
| x-ncp-apigw-timestamp | YES | It indicates the elapsed time in milliseconds since January 1, 1970 00:00:00 UTC. Request is considered invalid if the timestamp differs from the current time by more than 5 minutesx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | Access key ID value issued on NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | YES | Signature encrypted with the access key ID value and secret keyx-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 | GLOBAL_CDN, GLOBAL_EDGE | |
| cdn.instanceNo | String | 0 if NO_CDN | |
| cdn.profileId | Integer | Profile ID of Global Edge | 0 if NO_CDN |
| 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 | Respond only if schedules exist | |
| scheduleList.scheduleId | Integer | ||
| scheduleList.status | String | ||
| drmEnabledYn | Boolean | Whether DRM encryption settings are applied | |
| drm | Object | Set DRM encryption using Live Station When setting DRM, FairPlay, Widevine/PlayReady DRMs are supported | |
| drm.siteId | String | Site id created with One Click Multi DRM product | |
| drm.contentId | String | Unique ID of the content to apply DRM encryption to It is used for DRM packaging and can be at least 3 characters and up to 100 characters, including English letter, numbers, "-" (hyphen), and "_" (underscore) |
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": "edge-ls-20201204112949-D7RTL",
"statusName": "RUNNING",
"cdnType": "GLOBAL_EDGE",
"cdnDomain": "mycdn.edge.naverncp.com",
"profileId": 299,
"regionType": "KOREA"
},
"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?