チャンネルライブリストの照会
    • PDF

    チャンネルライブリストの照会

    • PDF

    記事の要約

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

    ユーザーチャンネルのライブリスト情報を照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、配信開始プロセスをご参照ください。

    リクエスト

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

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

    リクエストヘッダ

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

    名前タイプ説明必須有無
    x-prism-access-tokenStringOAuth2.0認証により発行した Access TokenY

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

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

    名前タイプ説明必須有無
    channelIdString照会対象チャンネル IDY

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

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

    名前タイプ説明必須有無
    statusString
  • 照会対象ライブの状態
  • ALL、RESERVED、ON_AIR、END
  • デフォルト値: ALL
  • Y

    レスポンス

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

    参考

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

    名前タイプ説明必須有無
    channelIdStringチャンネル IDY
    livesObjectライブリストY

    live dto

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

    liveStat dto

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

    構文例を紹介します。

    リクエスト例

    構文例は次の通りです。

    curl -X GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives
        -H "x-prism-access-token: {access-token}"
    

    レスポンス例

    構文例は次の通りです。

    {
        "success": true,
        "errorCode": 0,
        "errorName": null,
        "message": null,
        "data": {
            "lives": [
                {
                    "liveId": 14293,
                    "title": "ライブ中です。",
                    "description": "ライブの説明です。",
                    "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": "ライブです。",
                    "description": "終了したライブです。",
                    "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
        }
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.