ライブの状態と統計の照会

Classic/VPC環境で利用できます。

ライブの現在の状態(ライブ前、ライブ中、ライブ後)および統計情報(ライブの視聴者数、いいね数など)を照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、配信中プロセスをご参照ください。

リクエスト

リクエスト形式は次の通りです。

GET {serviceApiDomain}/prism/v1/service/live/{liveId}

リクエストヘッダ

名前	タイプ	説明	必須の有無
x-prism-access-token	String	OAuth 2.0認証を通じて発行した Access Token	Y

リクエストパスパラメータ

パラメータの説明は次の通りです。

名前	タイプ	説明	必須の有無
liveId	String	ライブ ID	Y

レスポンス

レスポンス形式を説明します。

参考

レスポンスの基本形式は、APIレスポンスの基本形式をご参照ください。

名前	タイプ	説明	必須の有無
live	Object	ライブオブジェクト	Y

live dto

live dtoの説明は次の通りです。

이름	타입	설명	필수 여부
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:// 로 시작	Y
status	Enumeration [RESERVED, ON_AIR, END]	라이브 상태 상태 관리를 하지 않는 서비스의 경우, ON_AIR를 기본값으로 제공	Y
scope	Enumeration [PUBLIC, LIMITED, PRIVATE]	라이브 공개 범위 PUBLIC: 공개, LIMITED: 일부 공개, PRIVATE: 비공개	N
liveLink	String	해당 라이브를 볼 수 있는 서비스 링크 없다면, 채널 홈 링크	Y
liveStat	Object	라이브 통계 정보	N

liveStat dto

liveStat dtoの説明は次の通りです。

이름	타입	설명
viewCount	Number	방송 시작부터 누적된 시청자 수
viewerCount	Number	현재 시청자 수 시청자 수 기준 1분 단위로 권장
likeCount	Number	방송 시작부터 누적된 좋아요 수
chatCount	Number	방송 시작부터 누적된 채팅 수

例

構文の例を紹介します。

リクエスト例

構文のサンプルコードは次の通りです。

curl -X GET {serviceApiDomain}/prism/v1/service/live/{liveId}
    -H "x-prism-access-token: {access-token}"

レスポンス例

構文のサンプルコードは次の通りです。

{
    "success": true,
    "errorCode": 0,
    "errorName": null,
    "message": null,
    "data": {
        "channelId": 27155,
        "live": {
            "liveId": 57082,
            "title": "プリズムライブです。",
            "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": 153,
                "viewerCount": 55,
                "likeCount": 34,
                "chatCount": 15
            }
        }
    }
}