Start live
- Print
- PDF
Start live
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
It is an API to start a live. For the use flow of B2B PRISM Live Studio, see Go live process.
Note
Services that don't support the live start/close function provide rtmpPath only. If a live is being transmitted on the same channel upon starting the live, it closes it forcibly and starts a new live.
Requests
The request format is as follows:
PUT /prism/v1/service/live/{liveId}/start
Request headers
The description of the header is as follows:
| Name | Type | Description | Required |
|---|---|---|---|
| x-prism-access-token | String | Access Token issued through OAuth2.0 authorization | Y |
Request path parameters
The description of the parameters is as follows:
| Name | Type | Description | Required |
|---|---|---|---|
| liveId | String | Live ID | Y |
Responses
This is a description of the response format.
Note
For the basic response format, see the Basic format for API responses.
| Name | Type | Description | Required |
|---|---|---|---|
| live | Object | Live object | Y |
live dto
The description of the live dto is as follows:
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| liveId | String | 라이브 ID. 방송 조회 시 사용됨 | Y |
| title | String | 라이브 제목을 지원하지 않는 서비스에서는 채널 이름을 전달해 주어야 함 | Y |
| description | String | 라이브 설명 | N |
| reservedAt | Date | Y | |
| startAt | Date | N | |
| rtmpPath | String | Y | |
| status | Enumeration [RESERVED, ONAIR, END] | Y | |
| scope | Enumeration [PUBLIC, LIMITED, PRIVATE] | Y | |
| liveLink | String | Y | |
| liveStat | Object | 라이브 통계 정보 | N |
liveStat dto
The description of the liveStat dto is as follows:
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| viewCount | Number | 방송 시작부터 누적된 시청자 수 | |
| viewerCount | Number | ||
| likeCount | Number | 방송 시작부터 누적된 좋아요 수 | |
| chatCount | Number | 방송 시작부터 누적된 채팅 수 |
Examples
Introduces examples of syntax.
Request examples
An example of the syntax is as follows:
curl -X PUT /prism/v1/service/live/{liveId}/start
-H "x-prism-access-token: {access-token}"
Response examples
An example of the syntax is as follows:
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"liveId": 57082,
"title": "This is the live title.",
"description": "This is a description of the live.",
"reservedAt": "2023-12-13T02:00:00+09:00",
"startAt": "2023-12-29T23:59:00+09:00",
"rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/scr14opcsi1tgvvxl4av1a1x3i3u6dha",
"status": "ON_AIR",
"liveLink": "https://example.com/1391275",
"scope": "PUBLIC",
"liveStat": {
"viewCount": null,
"viewerCount": null,
"likeCount": null,
"chatCount": null
}
}
}
Was this article helpful?