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

    チャンネルリストの照会

    • PDF

    記事の要約

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

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

    リクエスト

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

    GET {serviceApiDomain}/prism/v1/service/channel/list
    

    リクエストヘッダ

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

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

    レスポンス

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

    参考

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

    名前タイプ説明必須有無
    userNameStringB2B PRISM Live Studioで表示されるユーザー名Y
    channelsObjectchannelリストY

    channel DTO

    channel DTOの説明は、次の通りです。

    構文例を紹介します。

    リクエスト例

    構文例は次の通りです。

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

    レスポンス例

    構文例は次の通りです。

    {
        "success": true,
        "errorCode": 0,
        "errorName": null,
        "message": null,
        "data": {
            "channels": [
                {
                    "channelId": 2a7b15c5,
                    "channelName": "チャンネル ro4",
                    "channelEnabled": true,
                    "channelLink": "https://prismlive.com",
                    "channelDescription": "チャンネル ro4のチャンネルです。",
                    "channelTags": "モクバン",
                    "channelThumbnailUrl": null,
                    "channelFollowerCount": 12345
                },
                {
                    "channelId": 2e284f3g,
                    "channelName": "チャンネル62k",
                    "channelEnabled": false,
                    "channelLink": "https://prismlive.com",
                    "channelDescription": "チャンネル62kのチャンネルです。",
                    "channelTags": null,
                    "channelThumbnailUrl": null,
                    "channelFollowerCount": 12345
                },
                {
                    "channelId": 18243eab,
                    "channelName": "チャンネル iq4",
                    "channelEnabled": true,
                    "channelLink": "https://prismlive.com",
                    "channelDescription": "ポストマンで作成した新規チャンネルです。",
                    "channelTags": "モクバン",
                    "channelThumbnailUrl": null,
                    "channelFollowerCount": 0
                }
            ],
            "userName": "管理者"
        }
    }
    

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

    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.