Create channel
- Print
- PDF
Create channel
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
An API to create Re-Stream channels of Live Station. Provides the Channel list view API and the Channel information view API to view the created Re-Stream channels.
Requests
POST https://livestation.apigw.ntruss.com/api/v2/re-stream/channels
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 longerx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | Access key ID value issued from 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} |
| Content-Type | YES | Specifies the request body content type as application/jsonContent-Type: application/json |
| x-ncp-region_code | YES | Region code (KR) |
Request bodies
| Field name | Required | Type | Service limits | Description |
|---|---|---|---|---|
| channelName | Yes | String | 3 to 20 characters can be entered. Underscores (_) allowed | Name of the channel to be created |
| envType | Optional | String | DEV, STAGE, REAL | Settings for usage classification of the channel to be created. Will be set to REAL if not entered |
| planType | Yes | String | STANDARD, PROFESSIONAL | |
| restream | Yes | Object[] | ||
| restream[].targetName | Yes | String | YOUTUBE, CHZZK, STEAM, YOUNOW, USTREAM, AFREECATV, PRISM, CUSTOM | Platform name to be re-streamed |
| restream[].rtmpUrl | Yes | String | ||
| restream[].streamKey | Yes | String | ||
| restream[].id | No | String | RTMP authentication ID | |
| restream[].password | No | String | RTMP authentication password |
Responses
| Field name | Type | Description | Note |
|---|---|---|---|
| channelId | String | ||
| channelName | String | ||
| envType | String | DEV, STAGE, REAL | |
| instanceNo | Integer | ||
| channelStatus | String | CREATING, READY, PUBLISH, DELETED, BLOCK, FORCE_BLOCK, FORCE_DELETED | |
| createdTime | Integer | ||
| streamKey | String | ||
| publishUrl | String | ||
| globalPublishUrl | String | URL for supporting overseas streaming | |
| planType | String | STANDARD, PROFESSIONAL | |
| restream | Object[] | ||
| restream[].targetName | String | ||
| restream[].rtmpUrl | String | ||
| restream[].streamKey | String | ||
| restream[].id | String | ||
| restream[].password | String | ||
| platformCount | Integer | ||
| totalPublishSeconds | Integer | ||
| alertOn | Boolean | ||
| isPublishing | Boolean |
Examples
Request examples
POST /api/v2/re-stream/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
{
"channelName":"myrestream",
"planType":"STANDARD",
"restream":[
{
"targetName":"YOUTUBE",
"rtmpUrl":"rtmp://notworking-just-testcase.only"
},
{
"targetName":"TWITCH",
"rtmpUrl":"rtmp://notworking-just-testcase.only",
"streamKey":"12345",
"id":"itisid",
"password":"itispassword"
}
]
}
Response examples
HTTP/1.1 200 OK
Server: nginx
Date: Mon, 2 Mar 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-20200327014626-Nh91v",
"channelName":"myrestream",
"instanceNo":1168812,
"channelStatus":"READY",
"createdTime":1585241186000,
"streamKey":"7hdxzm1d1234du3qs",
"publishUrl":"rtmp://live-station-rtmp-url",
"globalPublishUrl": "rtmp://live-station-global-rtmp-url",
"planType":"STANDARD",
"restream":[
{
"targetName":"YOUTUBE",
"rtmpUrl":"rtmp://notworking-just-testcase.only"
},
{
"targetName":"TWITCH",
"rtmpUrl":"rtmp://notworking-just-testcase.only",
"streamKey":"12345",
"id":"itisid",
"password":"itispassword"
}
],
"platformCount":2,
"totalPublishSeconds":0,
"alertOn":false,
"isPublishing":false,
"envType": "REAL"
}
}
Was this article helpful?