GET/cxtalk/conversations/{conversationId}/messages

対応履歴内のメッセージのリストを取得する。

参考

  • contentType が IMAGE または FILE の場合、content に含まれる fileId を利用して、CXトーク - 対応履歴内の添付ファイルのダウンロード API でコンテンツを取得できる。

Authorization

oauth2

OAuth 2.0 認証。詳細は 認証・認可 をご参照ください。

Scope

cxtalk
cxtalk.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/cxtalk/conversations/{conversationId}/messages

Path Parameters

ParameterTypeDescription
conversationId string 

対応履歴 ID


required
example : 006576fa27717d8badcb9136a7693046 

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 10
minimum : 1
maximum : 100 
cursor string 

リストのカーソル値 (URL エンコードする)


example : eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
conversationId string 

対応履歴 ID


example : 006576fa27717d8badcb9136a7693046 
channelId string 

チャネル ID


example : 4f957d4c-56cf-6a5d-e451-1b3d0cfea7ce 
messages array (object) 

対応履歴のメッセージ一覧

 
responseMetaData object (responseMetaData) 
 

object

PropertyTypeDescription
messageId string 

メッセージ ID


example : msg-a1b2c3d4-e5f6-7890-abcd-ef1234567890 
messageType string 

メッセージレコードタイプ。現在は常に MESSAGE


example : MESSAGE 
sender object (sender) 

メッセージの送信者情報

 
contentType string 

メッセージコンテンツタイプ

  • TEXT: テキスト。
  • IMAGE: 画像。content には添付ファイルの fileId が含まれる。
  • FILE: ファイル。content には添付ファイルの fileId が含まれる。
  • STICKER: スタンプ。content にはスタンプ画像 URL が含まれる。
  • RICH_MESSAGE: リッチメッセージ（カード、カルーセル、フレックスなど）。content には未加工のペイロードが含まれる。

Allowed values : TEXT, IMAGE, FILE, STICKER, RICH_MESSAGE 
content string 

メッセージ内容。
contentType により含まれる情報が異なる

  • TEXT: テキスト。
  • IMAGE / FILE: 添付ファイル fileId。CXトーク - 対応履歴内の添付ファイルのダウンロード で利用する。
  • STICKER: スタンプ画像 URL。
  • RICH_MESSAGE: 未加工のペイロード。

example : いらっしゃいませ、何かお手伝いできますか？
nullable : true 
createdTime string 

メッセージ作成日時（ISO 8601 形式）。


example : 2026-01-15T10:05:30+09:00
format : date-time 

sender

PropertyTypeDescription
senderType string 

メッセージ送信者タイプ

  • AGENT: 窓口対応者が送信したメッセージ
  • CUSTOMER: 顧客が送信したメッセージ
  • SYSTEM: システムメッセージ（例: 参加/退出イベント）

required
Allowed values : AGENT, CUSTOMER, SYSTEM 
name string 

送信者の表示名


required
example : 山田 太郎 
id string 

送信者 ID。SYSTEM メッセージの場合は null。


example : 2f8985e7-ea92-47e9-a3d4-4d8976d330ee
nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のページ取得用カーソル。次のページがない場合は null。


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
nullable : true 

Response Example

example

1{2  "conversationId": "006576fa27717d8badcb9136a7693046",3  "channelId": "4f957d4c-56cf-6a5d-e451-1b3d0cfea7ce",4  "messages": [5    {6      "messageId": "msg-a1b2c3d4-e5f6-7890-abcd-ef1234567890",7      "messageType": "MESSAGE",8      "sender": {9        "senderType": "AGENT",10        "name": "山田 太郎",11        "id": "540b193b-7046-4e1d-aab0-b3f717fb3049"12      },13      "contentType": "TEXT",14      "content": "いらっしゃいませ、何かお手伝いできますか？",15      "createdTime": "2026-01-15T10:05:30+09:00"16    },17    {18      "messageId": "msg-b2c3d4e5-f6a7-8901-bcde-f12345678901",19      "messageType": "MESSAGE",20      "sender": {21        "senderType": "CUSTOMER",22        "name": "鈴木 花子",23        "id": "2f8985e7-ea92-47e9-a3d4-4d8976d330ee"24      },25      "contentType": "TEXT",26      "content": "アカウントの請求について問題があります。",27      "createdTime": "2026-01-15T10:06:12+09:00"28    },29    {30      "messageId": "msg-c3d4e5f6-a7b8-9012-cdef-123456789012",31      "messageType": "MESSAGE",32      "sender": {33        "senderType": "AGENT",34        "name": "山田 太郎",35        "id": "540b193b-7046-4e1d-aab0-b3f717fb3049"36      },37      "contentType": "IMAGE",38      "content": "jp1.400000393.400000393.1234567890123456789",39      "createdTime": "2026-01-15T10:07:00+09:00"40    },41    {42      "messageId": "msg-d4e5f6a7-b8c9-0123-defa-234567890123",43      "messageType": "MESSAGE",44      "sender": {45        "senderType": "SYSTEM",46        "name": "",47        "id": ""48      },49      "contentType": "TEXT",50      "content": "",51      "createdTime": "2026-01-15T10:30:00+09:00"52    }53  ],54  "responseMetaData": {55    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"56  }57}

HTTP 400

Bad Request

HTTP 401

Unauthorized

HTTP 403

Forbidden

HTTP 404

Not Found