チャットボット所属コンタクトのメッセージ一覧取得API

チャットボット所属コンタクトのメッセージ一覧取得APIは、チャットボットが結んでいる特定のコンタクトのメッセージ一覧を取得するAPIです。

通常のテキストメッセージのみ取得できます。

取得したメッセージは既読になり、コンタクト相手の既読数がリアルタイムにカウントアップされます。

リクエスト内容

フィールド名	フィールド値	備考
action	list_contact_messages	必須 「チャットボット所属コンタクトのメッセージ一覧取得API」であることを示します。
access_token	APIアクセスキー	必須 チャットボットの作成方法はこちらを参照してください。
user_id	メッセージ一覧を取得したいコンタクト相手のユーザーシステムID	必須 指定したユーザーとのコンタクトのメッセージ一覧を取得できます。
target	日時｜unread	必須 サーバー時間(UTC)を基準に、指定した日時以降に投稿されたメッセージのみを取得できます。 ※ 日時は2026-01-23T09:00:00の形式で指定してください。 未読のメッセージのみを取得したい場合は、unreadを指定してください。
limit	1～100の数値	任意 未指定時：100 最大取得件数を指定できます。 0以下の値や100より大きい値を指定した場合は100として扱われます。

リクエストの例

curl -X POST "https://your.domain/cgi-bin/chatlk/chatBot.cgi"
-F "action=list_contact_messages"
-F "access_token=(APIアクセスキー)"
-F "user_id=(ユーザーのシステムID)"
-F "target=2026-01-23T09:00:00"
-F "limit=10"

※ リクエスト先のURLは、お客様の環境に書き換えてください。
　 詳しくはリクエスト先のURLを参照してください。

レスポンス内容

フィールド名	フィールド値、意味
result	ok=成功、ng=失敗
server_time	成功した時のサーバー時間(UTC)
chat_id	メッセージ一覧を取得したコンタクトのシステムID
read_all	on=未読はない、off=未読がある
list.item	取得したメッセージ情報の配列 ※ メッセージ情報1件の内容は以下の表を参照してください。

メッセージ情報1件の内容

フィールド名	フィールド値、意味
id	メッセージのシステムID
message	メッセージの内容
created_time	メッセージを作成した時のサーバー時間(UTC)
updated_time	メッセージを更新した時のサーバー時間(UTC)
created_by	メッセージを投稿したユーザーのシステムID
created_by_name	メッセージを投稿したユーザーの名前
created_by_state	メッセージを投稿したユーザーの状態 active=有効なユーザー、released=本API実行時にコンタクトが解除されているユーザー、deleted=削除されたユーザー
member_count	メッセージ投稿時のメンバー数(自分を含まない)
read_count	コンタクト相手がメッセージを読んだかどうか 0=未読、1=既読

※ result以外の値はresult=okのときのみ含まれます。

※ result=ngのときのレスポンスについては共通仕様を参照してください。

レスポンス内容の例

// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2026-04-10T09:00:00",
  "chat_id": "1z73v9fr20un",
  "read_all": "on",
  "list": {
    "item": [
      {
        "id": "1z68b0kdhr5z",
        "message": "サンプルメッセージ",
        "created_time": "2026-02-25T09:40:20",
        "updated_time": "2026-02-25T09:40:20",
        "created_by": "1wkmq7ltrvo4",
        "created_by_name": "サンプルユーザー",
        "created_by_state": "active",
        "member_count": "1",
        "read_count": "1"
      },
      // 以降は省略
    ]
  }
}