채널 라이브 목록 조회
- 인쇄
- PDF
채널 라이브 목록 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
사용자 채널의 라이브 목록 정보를 조회하는 API입니다. B2B PRISM Live Studio에서의 사용 플로우를 확인하려면 방송 시작 프로세스를 참고해 주십시오.
요청
요청 형식은 다음과 같습니다.
GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| x-prism-access-token | String | OAuth2.0 인증을 통해 발급한 Access Token | Y |
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| channelId | String | 조회 대상 채널 ID | Y |
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| status | String | Y |
응답
응답 형식을 설명합니다.
참고
기본 응답 형식은 API 응답 기본 형식을 참고해 주십시오.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| channelId | String | 채널 ID | Y |
| lives | Object | 라이브 목록 | Y |
live dto
live dto에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| 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
liveStat dto에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| viewCount | Number | 방송 시작부터 누적된 시청자 수 | |
| viewerCount | Number | ||
| likeCount | Number | 방송 시작부터 누적된 좋아요 수 | |
| chatCount | Number | 방송 시작부터 누적된 채팅 수 |
예시
구문 예시를 소개합니다.
요청 예시
구문 예시는 다음과 같습니다.
curl -X GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives
-H "x-prism-access-token: {access-token}"
응답 예시
구문 예시는 다음과 같습니다.
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"lives": [
{
"liveId": 14293,
"title": "라이브 중 입니다.",
"description": "라이브 설명입니다.",
"reservedAt": "2023-10-26T17:11:44+09:00",
"startAt": "2023-10-26T17:11:44+09:00",
"rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/8cnft2bpuhdm1vlx58vfa5nx78rs",
"status": "ON_AIR",
"liveLink": "https://test.com/14293",
"scope": "LIMITED",
"liveStat": {
"viewCount": 163,
"viewerCount": 3,
"likeCount": 46,
"chatCount": 2
}
},
{
"liveId": 14286,
"title": "라이브 입니다.",
"description": "종료된 라이브 입니다.",
"reservedAt": "2023-10-26T17:09:15+09:00",
"startAt": "2023-10-26T17:09:57+09:00",
"rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/5izsqqbzr71sed7qn8vf8g2hx5at",
"status": "END",
"liveLink": "https://test.com/14293",
"scope": "PUBLIC",
"liveStat": {
"viewCount": 925,
"viewerCount": 60,
"likeCount": 166,
"chatCount": 2
}
}
],
"channelId": 1000
}
}
이 문서가 도움이 되었습니까?