ライブ開始

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

ライブを開始する APIです。B2B PRISM Live Studioでの使用フローを確認するには、配信開始プロセスをご参照ください。

参考

ライブ開始/終了機能をサポートしていないサービスは、rtmpPathのみ提供します。ライブ開始時に同じチャンネルで配信中のライブがある場合、強制終了して新規ライブを開始します。

リクエスト

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

PUT /prism/v1/service/live/{liveId}/start

リクエストヘッダ

ヘッダの説明は次の通りです。

名前	タイプ	説明	必須有無
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 PUT /prism/v1/service/live/{liveId}/start
    -H "x-prism-access-token: {access-token}"

レスポンス例

構文例は次の通りです。

{
    "success": true,
    "errorCode": 0,
    "errorName": null,
    "message": null,
    "data": {
        "liveId": 57082,
        "title": "ライブタイトルです。",
        "description": "ライブの説明です。",
        "reservedAt": "2023-12-13T02:00:00+09:00",
        "startAt": "2023-12-29T23:59:00+09:00",
        "rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/scr14opcsi1tgvvxl4av1a1x3i3u6dha",
        "status": "ON_AIR",
        "liveLink": "https://example.com/1391275",
        "scope": "PUBLIC",
        "liveStat": {
            "viewCount": null,
            "viewerCount": null,
            "likeCount": null,
            "chatCount": null
        }
    }
}