チャット照会

チャットを照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、チャットプロセスをご参照ください。

参考

ライブにチャットを送信、照会、削除します。
チャット照会は約5秒間隔でライブが終了するまで照会します。
チャット送信/照会/削除 APIが提供されていない場合、チャット機能を使用できません。
チャット送信 APIのみ提供できます。ただし、この場合はチャットを確認できません。

リクエスト

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

POST /prism/v1/service/live/{liveId}/chat

リクエストヘッダ

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

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

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

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

名前	タイプ	説明	必須有無
liveId	String	ライブ ID	Y

リクエストボディ

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

名前	タイプ	説明	必須有無
maxResults	Number	インポートするチャットメッセージの最大数最大値は100で、0または100以上の場合は100個のみ提供 0を指定した場合、すべてのメッセージを転送	Y
pageToken	String	前のページからインポートしたデータ以降のデータをインポートする際に使用 pageToken != nullの場合、指定された pageToken以降のチャットメッセージのリストを転送 pageToken = null & maxResults != 0の場合、最近のメッセージ - maxCountだけ提供 pageToken = null & maxResults = 0の場合、最近のメッセージ - 100だけ提供	Y

レスポンス

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

参考

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

名前	タイプ	説明	必須有無
liveId	String	ライブ ID	Y
nextPageToken	String	前に APIで照会して得た nextPageTokenを pageTokenに入力して照会すると、新しく入力されたチャットメッセージから照会もし新しく入力されたチャットメッセージがない場合、nextPageTokenはリクエストした pageTokenと同じ値を提供	Y
messages	Object	チャットメッセージリストチャットメッセージがない場合、その項目は empty arrayで提供	Y

message dto

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

名前	タイプ	説明	必須有無
messageId	String	チャットメッセージ ID もしチャット削除機能が提供されていない場合、messageIdは提供しなくても可能	N
messageAt	Date	チャットメッセージが入力された時間 ISO 8601形式で提供	N
authorId	String	チャットメッセージを入力した userId	Y
authorName	String	チャットメッセージを入力した userの名前名前のない userのチャットメッセージは無視可能	Y
authorProfileThumbnail	String	チャットメッセージを入力した user의 Thumbnail画像 authorProfileThumbnailがない場合、thumbnailは表示されない	N
isLiveOwner	Boolean	当該チャットのユーザーが現在ライブのストリーマであるかどうかプリズム内の IDが異なって表示されることがあるない場合、一般チャットと同様に表示	N
isLiveManager	Boolean	マネージャ機能を提供する場合、当該チャットのユーザーがマネージャであるかどうかプリズム内の IDが異なって表示されることがあるない場合、一般チャットと同様に表示	N

page tokenの提供方法

page tokenを提供する方法は、次の通りです。

b2bpls-chats_page-token_ko

例

構文例を紹介します。

リクエスト例

構文例は次の通りです。

curl -X POST /prism/v1/service/live/{liveId}/chat
    -H "x-prism-access-token: {access-token}"

レスポンス例

構文例は次の通りです。

{
    "success": true,
    "errorCode": 0,
    "errorName": null,
    "message": null,
    "data": {
        "liveId": 6,
        "nextPageToken": 8239,
        "messages": [
            {
                "messageId": 12,
                "message": "チャット作成テスト 2023-09-05 11:10:27",
                "messageAt": "2023-09-05T11:10:27+09:00",
                "authorId": "admin",
                "authorName": "管理者",
                "authorProfileThumbnail": null,
                "isLiveOwner": true,
                "isLiveManager": false
            },
            {
                "messageId": 13,
                "message": "チャット作成テスト 2023-09-05 11:25:11",
                "messageAt": "2023-09-05T11:25:11+09:00",
                "authorId": "admin",
                "authorName": "管理者",
                "authorProfileThumbnail": null,
                "isLiveOwner": true,
                "isLiveManager": false
            }
        ]
    }
}