查询消息清单。
接口说明
-
您可调用此接口查询消息清单，也可在通道管理>管理>消息清单界面进行查看。
-
该 API 仅支持查询 WhatsApp类型的通道消息清单。
-
在调用此接口前，请确保您已创建 WhatsApp类型通道；已绑定号码或商家账号 ID；已创建模板且完成审核；已使用通道发送消息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。