チャット照会
- 印刷する
- PDF
チャット照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
チャットを照会する 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 | Y | |
pageToken | String | Y |
レスポンス
レスポンス形式を説明します。
参考
デフォルトのレスポンス形式は APIレスポンスのデフォルト形式をご参照ください。
名前 | タイプ | 説明 | 必須有無 |
---|---|---|---|
liveId | String | ライブ ID | Y |
nextPageToken | String | Y | |
messages | Object | Y |
message dto
message dtoの説明は、次の通りです。
名前 | タイプ | 説明 | 必須有無 |
---|---|---|---|
messageId | String | N | |
messageAt | Date | N | |
authorId | String | Y | |
authorName | String | Y | |
authorProfileThumbnail | String | N | |
isLiveOwner | Boolean | N | |
isLiveManager | Boolean | N |
page tokenの提供方法
page tokenを提供する方法は、次の通りです。
例
構文例を紹介します。
リクエスト例
構文例は次の通りです。
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
}
]
}
}
この記事は役に立ちましたか?