- Print
- PDF
Start live
- Print
- PDF
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.
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:
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.
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:
Response examples
An example of the syntax is as follows: