ライブ作成

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

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

リクエスト

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

POST /prism/v1/service/channel/{channelId}/live

リクエストヘッダ

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

名前	タイプ	説明	必須有無
x-prism-access-token	String	OAuth2.0認証により発行した Access Token	Y

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

パラメータについての説明は、次の通りです。

名前	タイプ	説明	必須有無
channelId	String	チャンネル ID	Y

リクエストボディ

ボディの説明は次の通りです。

名前	タイプ	説明	必須有無
title	String	ライブタイトルライブタイトルをサポートしていない場合、無視可能	Y
reservedAt	Date	ライブ予約時間予約ライブでない場合、ライブの作成時間 ISO 8601形式で提供	Y
description	String	ライブの説明	Y
scope	Enumeration [PUBLIC, LIMITED, PRIVATE]	ライブの公開範囲 PUBLIC: 全体公開(default)、LIMITED: 一部公開、PRIVATE: 非公開	Y

レスポンス

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

参考

デフォルトのレスポンス形式は APIレスポンスのデフォルト形式をご参照ください。

名前	タイプ	説明	必須有無
channelId	String	チャンネル ID	Y
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": 0,
                "viewerCount": 0,
                "likeCount": 0,
                "chatCount": 0
            }
        }
    }
}