チャンネル情報の照会

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

レスポンス

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

参考

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

名前	タイプ	説明	必須有無
userName	String	B2B PRISM Live Studioで表示されるユーザー名	Y
channel	Object	channelオブジェクト	Y

channel DTO

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

例

構文例を紹介します。

リクエスト例

構文例は次の通りです。

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

レスポンス例

構文例は次の通りです。

{
    "success": true,
    "errorCode": 0,
    "errorName": null,
    "message": null,
    "data": {
        "channel": {
            "channelId": 1,
            "channelName": "アドミン TV",
            "channelEnabled": true,
            "channelLink": "https://prismlive.com",
            "channelDescription": "アドミンアドミン",
            "channelTags": "モクバン;トーク",
            "channelThumbnailUrl": "https://thumbnail123.png",
            "channelFollowerCount": 999
        },
        "userName": "管理者"
    }
}

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

リクエスト
- リクエストヘッダ
- リクエストパスパラメータ
レスポンス
- channel DTO
例
- リクエスト例
- レスポンス例