Viewing channel live list

Available in Classic and VPC

It is an API to view the user channel’s live list information. For the use flow of B2B PRISM Live Studio, see Go live process.

Requests

The request format is as follows:

GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives

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
channelId	String	Targeted channel ID to view	Y

Request query parameters

The description of the parameters is as follows:

Name	Type	Description	Required
status	String	Live status of viewing target ALL, RESERVED, ON_AIR, END Default: ALL	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
channelId	String	Channel ID	Y
lives	Object	Live list	Y

live dto

The description of the live dto is as follows:

이름	타입	설명	필수 여부
liveId	String	라이브 ID. 방송 조회 시 사용됨	Y
title	String	라이브 제목을 지원하지 않는 서비스에서는 채널 이름을 전달해 주어야 함	Y
description	String	라이브 설명	N
reservedAt	Date	라이브 예약시간 예약 라이브가 아닌 경우 라이브 생성 시간 ISO 8601 형식으로 응답	Y
startAt	Date	라이브 시작 시간 ISO 8601 형식으로 응답	N
rtmpPath	String	송출 RTMP URL rtmp:// 또는 rtmps:// 로 시작 라이브 시작 후에만 제공되는 서비스에서는, 라이브 시작 후에만 rtmpPath를 제공	Y
status	Enumeration [RESERVED, ONAIR, END]	라이브 상태 상태 관리를 하지 않는 서비스의 경우, ON_AIR를 기본값으로 제공	Y
scope	Enumeration [PUBLIC, LIMITED, PRIVATE]	라이브 공개 범위 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	현재 시청자 수 시청자 수 기준 1분 단위로 권장
likeCount	Number	방송 시작부터 누적된 좋아요 수
chatCount	Number	방송 시작부터 누적된 채팅 수

Examples

Introduces examples of syntax.

Request examples

An example of the syntax is as follows:

curl -X GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives
    -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": {
        "lives": [
            {
                "liveId": 14293,
                "title": "On-air.",
                "description": "A description of the live.",
                "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": "This is a live.",
                "description": "This live has ended.",
                "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
    }
}