View channel information

Article Summary

Share feedback

Thanks for sharing your feedback!

Live Station provides an API to view details about the channel.

Requests

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

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
channelId	String
channelName	String
instanceNo	String
qualitySetId	Integer
qualitySetName	String
outputProtocol	String
channelStatus	String	CREATING, READY, PUBLISH, DELETED,BLOCK, FORCE_BLOCK, FORCE_DELETED
isRecording	Boolean
useDvr	Boolean
immediateOnAir	Boolean	true, false
timemachineMin	Integer		Unit: minute
uploadPath	String	In case of AUTO_UPLOAD option, the path to upload recording files
snapshot	Object
snapshotId	Integer
record	Object
record.format	String	MP4,HLS,ALL
record.type	String	NO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD
record.bucketName	String
record.filePath	String
record.accessControl	String	PRIVATE, PUBLIC_READ
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, ""
publishUrl	String
globalPublishUrl	String	URL for supporting overseas streaming
streamKey	String
recentPublishStartTime	Integer
createdTime	Integer
alertOn	Boolean
alertOptions	Object
alertOptions.alertChangeStatus	Boolean
alertOptions.alertVodUploadFail	Boolean
alertOptions.alertReStreamFail	Boolean
totalPublishSeconds	Integer
envType	String	DEV, STAGE, REAL
callbackEndpoint	String
backupStreamKey	String	Backup stream key for streaming redundancy
isStreamFailOver	Boolean	Whether to apply streaming redundancy settings	true, false
origin	Object	Live Station original information for integrating with CDN
origin.originDomain	String	Live Station original domain for integrating with CDN
origin.originPath	String	Live Station original detailed path for integrating with CDN
drmEnabledYn	Boolean	Whether to apply DRM Encryption settings
drm	Object	DRM Encryption settings using Live Station
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/channels/ls-20200323114720-bMoDF
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 Sep 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-20200323114720-bMoDF",
        "channelName" : "mychannel",
        "instanceNo" : 1163899,
        "qualitySetId" : 6,
        "qualitySetName" : "360p-set",
        "outputProtocol" : "HLS, DASH",
        "channelStatus" : "READY",
        "isRecording" : false,
        "useDVR" : true,
        "immediateOnAir" : false,
        "timemachineMin" : 360,
        "cdn" : {
            "instanceNo" : "1163900",
            "serviceName" : "edge-ls-20230914204831-1BRHO",
            "statusName" : "RUNNING",
            "cdnType" : "GLOBAL_EDGE",
            "cdnDomain" : "mycdn.cdn.ntruss.com",
            "profileId" : 299
        },
        "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "hls",
            "filePath": "/livestation",
            "format": "MP4",
            "accessControl": "PRIVATE"
       },
       "drm": {
          "contentId": "my-first-drm",
          "siteId": "drm-20231120182420-dPTGn"
       },
        "drmEnabledYn": true,
        "uploadPath": "/hls/livestation",
        "publishUrl": "rtmp://live-station-rtmp-url",
        "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
        "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
        "totalPublishSeconds" : 0,
        "createdTime" : 1584931640000,
        "recentPublishStartTime": 0,
        "alertOn" : false,
        "alertOptions" : {
            "alertChangeStatus" : false,
            "alertVodUploadFail" : false,
            "alertReStreamFail" : false
        },
        "callbackEndpoint": "https://my-callback-endpoint",
        "envType": "REAL",
        "origin": {
          "originDomain": "ls-k1.video.media.ntruss.com",
          "originPath": "1"
     },
     "backupStreamKey": "lbuy4dcrxk2ctxs8uqxanpy833p08vvz?backup=true",
     "isStreamFailOver": true
    }
}

Was this article helpful?

What's Next

View channel list

Table of contents

Requests
Responses
Examples