Classic/VPC環境で利用できます。
ライブの現在の状態(ライブ前、ライブ中、ライブ後)および統計情報(ライブの視聴者数、いいね数など)を照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、放送中プロセスをご参照ください。
リクエスト
リクエスト形式は次の通りです。
GET {serviceApiDomain}/prism/v1/service/live/{liveId}
リクエストヘッダ
| 名前 | タイプ | 説明 | 必須有無 |
|---|---|---|---|
| x-prism-access-token | String | OAuth2.0認証により発行した Access Token | Y |
リクエストパスパラメータ
パラメータについての説明は、次の通りです。
| 名前 | タイプ | 説明 | 必須有無 |
|---|---|---|---|
| liveId | String | ライブ ID | Y |
レスポンス
レスポンス形式を説明します。
参考
デフォルトのレスポンス形式は APIレスポンスのデフォルト形式をご参照ください。
| 名前 | タイプ | 説明 | 必須有無 |
|---|---|---|---|
| live | Object | ライブオブジェクト | Y |
live dto
live dtoの説明は、次の通りです。
liveStat dto
liveStat dtoの説明は、次の通りです。
例
構文例を紹介します。
リクエスト例
構文例は次の通りです。
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
}
}
}
}