メッセージリストの照会

Prev Next

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

チャンネルのメッセージリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /v1/api/messages/{channelId}

リクエストヘッダ

Ncloud Chat APIで共通して使用されるヘッダの詳細は、Ncloud Chatのリクエストヘッダをご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID

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

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
filter String Required 絞り込み条件
  • レスポンスボディの一部のフィールドに基づいて絞り込み
  • 完全一致する値のみ絞り込み
  • 条件がない場合、空の値{}を入力
  • <例> {"sender.name":"{送信者名}"}、{"content":"{内容の一部}"}
sort String Optional ソートの基準
  • {基準:方式}形式で入力
    • 基準: レスポンスボディの Stringタイプフィールド
    • 方式: -1 | 1
      • -1: 降順
      • 1: 昇順
  • <例> {"created_at":"-1"}: 作成日時基準の降順
option String Optional 追加オプション: Option
  • <例> {"offset":0,"per_page":20}: 最初の項目から20個表示

Option

Optionの説明は次の通りです。

フィールド タイプ 必須の有無 説明
offset Number Optional 照会開始オフセット
  • 0~N
per_page Number Optional ページごとの項目数
  • 1~100

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/4073efd6-****-****-****-cc4550fed7b7
?filter=%7B%22content%22%3A%22messa%22%7D
&sort=%7B%22created_at%22%3A%22-1%22%7D
&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
id String - メッセージ ID
message_id String - メッセージ ID
channel_id String - チャンネル ID
sort_id String - 送信日時
  • Unix Timestamp形式
message_type String - メッセージのタイプ
  • text | file
sender Object - 送信者情報
sender.id String - 送信者 ID
sender.name String - 送信者名
sender.profile String - 送信者プロファイル画像
admin Object - 管理者情報
admin.id String - 管理者 ID
admin.name String - 管理者名
admin.profile String - 管理者プロファイル画像
attachment_filenames Object - 添付ファイル情報
attachment_filenames.name String - 添付ファイル名
attachment_filenames.size Number - 添付ファイルサイズ(Bytes)
attachment_filenames.type String - 添付ファイルタイプ
attachment_filenames.url String - 添付ファイルの URL
has String - 添付特殊項目の区分 (デフォルト: "")
  • <例> link、image、video、file
embed_providers String - 添付エンベッド特殊項目の提供者
embed_type String - エンベッド特殊項目のタイプ (デフォルト: "")
isExpress Boolean - エクスプレスメッセージかどうか
  • true | false (デフォルト)
    • true: エクスプレスメッセージ
    • false: 通常のメッセージ
link_hostnames String - リンクホスト名
  • hasが linkの場合
mentions Array - メンション情報 (デフォルト: [])
mentions_everyone Boolean - 全員メンションかどうか
  • true | false (デフォルト)
    • true: 全員メンション
    • false: 全員メンションではない
content String - メッセージの内容
sended_at String - メッセージ送信日時
  • ISO 8601形式
created_at String - メッセージ作成日時
  • ISO 8601形式

レスポンスステータスコード

Ncloud Chat APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Chatのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
    {
        "id": "6836b8**********7d65352a",
        "message_id": "6836b8**********7d65352a",
        "channel_id": "4073efd6-****-****-****-cc4550fed7b7",
        "sort_id": "1748416572780",
        "message_type": "text",
        "sender": {
            "id": "radevjs",
            "name": "radevjs",
            "profile": ""
        },
        "admin": {
            "id": "",
            "name": "",
            "profile": ""
        },
        "attachment_filenames": {
            "name": "",
            "size": 0,
            "type": "text",
            "url": ""
        },
        "has": "",
        "embed_providers": "",
        "embed_type": "",
        "isExpress": false,
        "link_hostnames": "",
        "mentions": [],
        "mentions_everyone": "false",
        "content": "message04",
        "sended_at": "2025-05-28T16:16:12+09:00",
        "created_at": "2025-05-28T16:16:12+09:00"
    },
    ...
]