---
title: "チャットの照会"
slug: "b2bpls-chats"
updated: 2026-10-08T07:15:01Z
published: 2026-10-08T07:15:01Z
canonical: "api.ncloud-docs.com/b2bpls-chats"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# チャットの照会

チャットを照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、[チャットプロセス](https://guide.ncloud-docs.com/docs/ja/b2bpls-chat)をご参照ください。

              参考

              

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

## リクエスト

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

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

### リクエストヘッダ

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

| 名前 | タイプ | 説明 | 必須の有無 |
| --- | --- | --- | --- |
| x-prism-access-token | String | OAuth 2.0認証を通じて発行した Access Token | Y |

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

パラメータの説明は次の通りです。

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

### リクエストボディ

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

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

## レスポンス

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

              参考

              

レスポンスの基本形式は、[APIレスポンスの基本形式](/docs/ja/b2bpls-overview#%EA%B8%B0%EB%B3%B8%EC%9D%91%EB%8B%B5%ED%98%95%EC%8B%9D)をご参照ください。

| 名前 | タイプ | 説明 | 必須の有無 |
| --- | --- | --- | --- |
| 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 |
| message | String | チャットメッセージ | Y |
| 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](https://cdn.document360.io/da0368a0-4444-4862-a528-42f78876f9e6/Images/Documentation/b2bpls-chats_page-token_ja.png?sv=2026-02-06&spr=https&st=2026-10-30T22%3A49%3A20Z&se=2026-10-30T23%3A49%3A20Z&sr=c&sp=r&sig=W1pE7bnPQ832deEETG%2FN6LAtPhRPvOukAsbIkCWl81Q%3D)

## 例

構文の例を紹介します。

### リクエスト例

構文のサンプルコードは次の通りです。

```
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
            }
        ]
    }
}
```