Available in Classic and VPC
Create a re-stream channel.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/re-stream/channels |
Request headers
For information about the headers common to all Live Station APIs, see Live Station request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
channelName |
String | Required | Channel name
|
planType |
String | Required | Pricing plan type
|
envType |
String | Optional | Channel type
|
restream |
Array | Required | Re-stream platform list: restream |
restream
The following describes restream
.
Field | Type | Required | Description |
---|---|---|---|
targetName |
String | Required | Re-stream platform name
|
rtmpUrl |
String | Required | Re-stream platform RTMP URL |
streamKey |
String | Required | Re-stream platform stream key |
id |
String | Optional | RTMP authentication ID
|
password |
String | Optional | RTMP authentication password
|
Request example
The request example is as follows:
curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/re-stream/channels' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR' \
--data '{
"channelName": "channel001",
"planType": "STANDARD",
"envType": "REAL",
"restream": [
{
"targetName": "YOUTUBE",
"rtmpUrl": "rtmp://rtmp-test.youtube.com",
"streamKey": "****-****-****-****-****",
"id": "user000",
"password": "dbwj@@@123"
},
{
"targetName": "PRISM",
"rtmpUrl": "rtmp://abc.com",
"streamKey": "****-****-****-****-****",
"id": "user001",
"password": "dbwj@@!456"
}
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
content |
Object | - | Response result |
content.channelId |
String | - | Channel ID |
content.channelName |
String | - | Channel name |
content.instanceNo |
Integer | - | Channel instance number |
content.channelStatus |
String | - | Channel status
|
content.streamKey |
String | - | Stream key |
content.publishUrl |
String | - | Default transmission URL |
content.planType |
String | - | Pricing plan type
|
content.createdTime |
Integer | - | Channel creation date and time (millisecond)
|
content.restream |
Array | - | Re-stream platform information: restream |
content.platformCount |
Integer | - | Re-stream platform count |
content.totalPublishSeconds |
Integer | - | Channel usage time (second) |
content.alertOn |
Boolean | - | Event notification settings
|
content.isPublishing |
Boolean | - | Streaming status
|
content.envType |
String | - | Channel type
|
restream
The following describes restream
.
Field | Type | Required | Description |
---|---|---|---|
id |
String | - | RTMP authentication ID
|
rtmpUrl |
String | - | Re-stream platform RTMP URL |
streamKey |
String | - | Re-stream platform stream key |
password |
String | - | RTMP authentication password
|
targetName |
String | - | Re-stream platform name |
Response status codes
For information about the HTTP status codes common to all Live Station APIs, see Live Station response status codes.
Response example
The response example is as follows:
{
"content": {
"channelId": "ls-20250819******-Ik1QU",
"channelName": "channel001",
"instanceNo": 1082*****,
"channelStatus": "READY",
"streamKey": "zg******************************",
"publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
"planType": "STANDARD",
"createdTime": 1755571786244,
"restream": [
{
"id": "user000",
"rtmpUrl": "rtmp://rtmp-test.youtube.com",
"streamKey": "****-****-****-****-****",
"password": "dbwj@@@123",
"targetName": "YOUTUBE"
},
{
"id": "user001",
"rtmpUrl": "rtmp://abc.prism.com",
"streamKey": "****-****-****-****-****",
"password": "dbwj@@!456",
"targetName": "PRISM"
}
],
"platformCount": 2,
"totalPublishSeconds": 0,
"alertOn": false,
"isPublishing": false,
"envType": "REAL"
}
}