GET/cxtalk/conversations

対応履歴のリストを取得する。

  • 取得期間（開始日時〜終了日時）は最大 7 日間まで指定できる。開始日時 startTime と終了日時 endTime の両方を指定する。
  • 取得範囲を指定しない場合には、当日の対応履歴のみを取得する。

Authorization

oauth2

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

Scope

cxtalk
cxtalk.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/cxtalk/conversations

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 10
minimum : 1
maximum : 100 
cursor string 

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


example : eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30 
startTime string 

対応履歴日時フィルターの開始日時 (YYYY-MM-DDThh:mm:ssTZD)。

  • 「+」は「%2B」にURLエンコードする。

example : 2026-01-01T00:00:00%2B09:00 
endTime string 

対応履歴日時フィルターの終了日時 (YYYY-MM-DDThh:mm:ssTZD)。

  • 「+」は「%2B」にURLエンコードする。

example : 2026-01-07T23:59:59%2B09:00 
customerId string 

顧客 ID


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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
conversations array (object) 

対応履歴一覧

 
responseMetaData object (responseMetaData) 
 

object

PropertyTypeDescription
conversationId string 

対応履歴 ID


example : 006576fa27717d8badcb9136a7693046 
channelId string 

チャネル ID


example : 4f957d4c-56cf-6a5d-e451-1b3d0cfea7ce
nullable : true 
inquiryChannels object (inquiryChannels) 

問い合わせ経路

 
cxtalkAccount object (cxtalkAccount) 

対応履歴に関連付けられたCXトークの対応窓口

 
agentAccounts array (object) 

この対応履歴に参加した窓口対応者の一覧

 
customerAccount object 

顧客アカウント。顧客情報が取得できない場合には null


nullable : true 
startTime string 

対応履歴開始時間（ISO 8601 形式）


example : 2026-01-15T10:00:00+09:00
format : date-time
nullable : true 
endTime string 

対応履歴終了時間（ISO 8601 形式）


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

inquiryChannels

PropertyTypeDescription
channelType string 

問い合わせ経路タイプ

  • LINE_OA: LINE公式アカウント
  • WORKS: 外部LINE WORKS
  • MAIL: メール
  • INTERNAL: 社内窓口

required
Allowed values : LINE_OA, WORKS, MAIL, INTERNAL 

cxtalkAccount

PropertyTypeDescription
name string 

CXトークの対応窓口の表示名


example : サポートチーム 

responseMetaData

PropertyTypeDescription
nextCursor string 

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
nullable : true 

Response Example

example

1{2  "conversations": [3    {4      "conversationId": "006576fa27717d8badcb9136a7693046",5      "channelId": "4f957d4c-56cf-6a5d-e451-1b3d0cfea7ce",6      "inquiryChannels": {7        "channelType": "LINE_OA"8      },9      "cxtalkAccount": {10        "name": "サポートチーム"11      },12      "agentAccounts": [13        {14          "id": "540b193b-7046-4e1d-aab0-b3f717fb3049",15          "name": "山田 太郎"16        }17      ],18      "customerAccount": {19        "id": "2f8985e7-ea92-47e9-a3d4-4d8976d330ee",20        "name": "鈴木 花子"21      },22      "startTime": "2026-01-15T10:00:00+09:00",23      "endTime": "2026-01-15T10:30:00+09:00"24    },25    {26      "conversationId": "006576fa27717d8badcb9136a7693047",27      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",28      "inquiryChannels": {29        "channelType": "MAIL"30      },31      "cxtalkAccount": {32        "name": "メールサポート"33      },34      "agentAccounts": [35        {36          "id": "18de797d-5b18-4cd8-929a-438a033d52a4",37          "name": "佐藤 二郎"38        }39      ],40      "customerAccount": {41        "id": "2f7527e7-ea92-47e9-a3d4-4d8976d330ee",42        "name": "田中 次郎"43      },44      "startTime": "2026-01-14T14:00:00+09:00",45      "endTime": "2026-01-14T14:45:00+09:00"46    }47  ],48  "responseMetaData": {49    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="50  }51}

HTTP 400

Bad Request

HTTP 401

Unauthorized

HTTP 403

Forbidden