查詢訊息清單。
介面說明
-
您可呼叫此介面查詢訊息清單，也可在通道管理>管理>訊息清單介面進行檢視。
-
該 API 僅支援查詢 WhatsApp、Viber類型的通道訊息清單。
-
在呼叫此介面前，請確保您已建立 WhatsApp或 Viber類型通道；已綁定號碼或商家帳號 ID；已建立範本且完成審核；已使用通道傳送訊息。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cams:ListChatappMessage |
list |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| BusinessNumber |
string |
是 |
商家號碼。 |
8613800**** |
| StartTime |
integer |
否 |
開始時間。時間戳記，單位：毫秒。 |
1727057232686 |
| EndTime |
integer |
否 |
結束時間。時間戳記，單位：毫秒。 |
1727057232686 |
| EventAction |
string |
否 |
訊息類型。取值：
枚舉值：
|
UP |
| UserNumber |
string |
否 |
使用者號碼。指您在通道管理>管理>訊息傳送介面傳送訊息時匯入的使用者號碼。 |
86138*** |
| ChannelType |
string |
是 |
類型。取值：
|
|
| ClientAcceptStatus |
string |
否 |
使用者接收狀態。 |
success |
| TemplateCode |
string |
否 |
範本編碼。在通道管理>管理>範本設計介面檢視範本編碼。 |
9938*** |
| GroupMessageId |
string |
否 |
批次訊息 ID。您可在通道管理>管理>訊息清單>批次傳送清單介面檢視批次訊息 ID。 |
9292**** |
| MessageStatus |
string |
否 |
訊息狀態。 |
success |
| CustSpaceId |
string |
是 |
ISV 子客戶的 SpaceId/直客客戶執行個體 ID。在通道管理介面檢視 Space ID。 |
cams-************ |
| Page |
object |
是 |
分頁參數物件。 |
|
| Size |
integer |
是 |
每頁顯示的數目。 |
10 |
| Index |
integer |
是 |
頁碼。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AccessDeniedDetail |
string |
存取被拒絕詳細資訊。 |
None |
| Message |
string |
錯誤提示資訊。 |
None |
| RequestId |
string |
請求 ID。 |
608F9CCA-B5EB-3D72-8047-B25D6D75BDEC |
| Data |
array<object> |
返回資料物件列表。 |
|
|
object |
返回資料。 |
||
| ConversationId |
string |
對話 ID。 |
805a66************************** |
| BusinessNumber |
string |
商家號碼。 |
86183******** |
| ClientAcceptStatusName |
string |
訊息接收狀態名稱。 |
Success |
| Message |
string |
訊息內容。 |
test |
| MessageTypeName |
string |
訊息類型名稱。 |
interactive |
| FailReason |
string |
傳送失敗原因。 |
timeout |
| EventActionName |
string |
上行、下行訊息名稱。取值：
|
DOWN |
| Month |
string |
訊息月份。 |
202507 |
| LanguageCode |
string |
範本語言。更多語言請參見語言代碼。 |
en |
| TemplateName |
string |
範本名稱。 |
picture_template |
| MessageType |
string |
訊息類型。 |
INTERACTIVE |
| SendTime |
string |
傳送時間。 |
2025-07-11T01:16:49.761+00:00 |
| MessageStatusName |
string |
訊息狀態名稱。 |
Success |
| ClientReadStatus |
string |
訊息閱讀狀態。 |
success |
| MessageSource |
string |
訊息來源。 |
api |
| FailBackFlag |
string |
是否回落簡訊。取值：
|
Y |
| UserNumber |
string |
使用者號碼。 |
86177******** |
| TemplateCode |
string |
範本編碼。 |
1103*************** |
| MessageStatus |
string |
訊息狀態。 |
success |
| Type |
string |
類型。 |
message |
| FailBackContent |
string |
回落內容。 |
None |
| EventAction |
string |
訊息上行、下行類型。 |
DOWN |
| ClientReadStatusName |
string |
訊息閱讀狀態名稱。 |
Success |
| UniqueMessageId |
string |
訊息唯一 ID。 |
20250911****************************** |
| ChannelType |
string |
通道類型。 |
|
| MessageId |
string |
訊息 ID。 |
202509******************* |
| Code |
string |
請求狀態碼。
|
OK |
| Success |
boolean |
是否呼叫成功。取值：
|
false |
樣本
正常返回樣本
JSON格式
{
"AccessDeniedDetail": "None",
"Message": "None",
"RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC",
"Data": [
{
"ConversationId": "805a66**************************",
"BusinessNumber": "86183********",
"ClientAcceptStatusName": "Success",
"Message": "test",
"MessageTypeName": "interactive",
"FailReason": "timeout",
"EventActionName": "DOWN",
"Month": "202507",
"LanguageCode": "en",
"TemplateName": "picture_template",
"MessageType": "INTERACTIVE",
"SendTime": "2025-07-11T01:16:49.761+00:00",
"MessageStatusName": "Success",
"ClientReadStatus": "success",
"MessageSource": "api",
"FailBackFlag": "Y",
"UserNumber": "86177********",
"TemplateCode": "1103***************",
"MessageStatus": "success",
"Type": "message",
"FailBackContent": "None",
"EventAction": "DOWN",
"ClientReadStatusName": "Success",
"UniqueMessageId": "20250911******************************",
"ChannelType": "WHATSAPP",
"MessageId": "202509*******************"
}
],
"Code": "OK",
"Success": false
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。