Available in Classic and VPC
This API is used to create a new live stream. To view the usage flow in B2B PRISM Live Studio, see Broadcast start process.
Request
The method and URI are as follows:
POST /prism/v1/service/channel/{channelId}/live
Request headers
The following describes the headers.
| Name | Type | Description | Required |
|---|---|---|---|
| x-prism-access-token | String | Access token issued via OAuth 2.0 authorization | Y |
Request path parameters
The following describes the parameters.
| Name | Type | Description | Required |
|---|---|---|---|
| channelId | String | Channel ID | Y |
Request body
The following describes the body.
| Name | Type | Description | Required |
|---|---|---|---|
| title | String |
|
Y |
| reservedAt | Date |
|
Y |
| description | String | Live stream description | Y |
| scope | Enumeration [PUBLIC, LIMITED, PRIVATE] | Live public availability |
Y |
Response
This section describes the response format.
Note
For the default response format, see API response default format.
| Name | Type | Description | Required |
|---|---|---|---|
| channelId | String | Channel ID | Y |
| live | Object | Live object | Y |
live dto
The following describes the live dto.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| liveId | String | 라이브 ID. 방송 조회 시 사용됨 | Y |
| title | String | 라이브 제목을 지원하지 않는 서비스에서는 채널 이름을 전달해 주어야 함 | Y |
| description | String | 라이브 설명 | N |
| reservedAt | Date | Y | |
| startAt | Date | N | |
| rtmpPath | String | Y | |
| status | Enumeration [RESERVED, ON_AIR, END] | Y | |
| scope | Enumeration [PUBLIC, LIMITED, PRIVATE] | N | |
| liveLink | String | Y | |
| liveStat | Object | 라이브 통계 정보 | N |
liveStat dto
The following describes the liveStat dto.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| viewCount | Number | 방송 시작부터 누적된 시청자 수 | |
| viewerCount | Number | ||
| likeCount | Number | 방송 시작부터 누적된 좋아요 수 | |
| chatCount | Number | 방송 시작부터 누적된 채팅 수 |
Examples
Here are some example syntaxes.
Request example
The following is a sample syntax.
curl -X POST {serviceApiDomain}/prism/v1/service/live/{liveId}
-H "x-prism-access-token: {access-token}"
Response example
The following is a sample syntax.
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"channelId": 27155,
"live": {
"liveId": 57082,
"title": "This is PRISM Live.",
"description": "This is live description.",
"reservedAt": "2023-12-13T02:00:00+09:00",
"startAt": null,
"rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/scr14i1tgvvxl4av1a1x3i3u6dha",
"status": "RESERVED",
"liveLink": "https://example.com/1391275",
"scope": "PUBLIC",
"liveStat": {
"viewCount": 0,
"viewerCount": 0,
"likeCount": 0,
"chatCount": 0
}
}
}
}