查询消息清单。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| BusinessNumber |
string |
是 |
商家号码。 |
8613800**** |
| StartTime |
integer |
否 |
开始时间。支持的格式：Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。 |
1727057232686 |
| EndTime |
integer |
否 |
结束时间。支持的格式：Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。 |
1727057232686 |
| EventAction |
string |
否 |
消息类型。 |
UP |
| UserNumber |
string |
否 |
用户号码。 |
86138*** |
| ChannelType |
string |
是 |
类型。取值：
|
|
| ClientAcceptStatus |
string |
否 |
用户接收状态。 |
success |
| TemplateCode |
string |
否 |
模板编码。 |
9938*** |
| GroupMessageId |
string |
否 |
批量消息 ID。 |
9292**** |
| MessageStatus |
string |
否 |
消息状态。 |
success |
| CustSpaceId |
string |
是 |
ISV 子客户的 SpaceId/直客客户实例 ID。 |
示例值示例值示例值 |
| Page |
object |
是 |
分页参数对象 |
|
| Size |
integer |
是 |
每页展示的数目。 |
10 |
| Index |
integer |
是 |
页码。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
无 |
| Message |
string |
错误提示信息。 |
示例值 |
| RequestId |
string |
请求 ID。 |
示例值 |
| Data |
array<object> |
返回数据对象。 |
|
|
object |
返回数据。 |
||
| ConversationId |
string |
会话 id。 |
示例值示例值 |
| BusinessNumber |
string |
商家号码。 |
示例值示例值 |
| ClientAcceptStatusName |
string |
消息接收状态名称。 |
示例值示例值示例值 |
| Message |
string |
消息内容。 |
示例值示例值 |
| MessageTypeName |
string |
消息类型名称。 |
示例值示例值 |
| FailReason |
string |
发送失败原因。 |
示例值示例值 |
| EventActionName |
string |
上行、下行消息名称。 |
示例值 |
| Month |
string |
消息月份。 |
示例值示例值 |
| LanguageCode |
string |
模板语言。 |
示例值示例值 |
| TemplateName |
string |
模板名称。 |
示例值示例值 |
| MessageType |
string |
消息类型。 |
示例值示例值 |
| SendTime |
string |
发送时间。 |
示例值示例值 |
| MessageStatusName |
string |
消息状态名称。 |
示例值 |
| ClientReadStatus |
string |
消息阅读状态。 |
示例值示例值 |
| MessageSource |
string |
消息来源。 |
示例值示例值 |
| FailBackFlag |
string |
是否回落短信。 |
Y |
| UserNumber |
string |
用户号码。 |
示例值示例值示例值 |
| TemplateCode |
string |
模板编码。 |
示例值示例值 |
| MessageStatus |
string |
消息状态。 |
示例值示例值 |
| Type |
string |
类型。 |
示例值示例值 |
| FailBackContent |
string |
回落内容。 |
示例值 |
| EventAction |
string |
消息上行、下行类型。 |
示例值示例值 |
| ClientReadStatusName |
string |
消息阅读状态名称。 |
示例值示例值 |
| UniqueMessageId |
string |
消息唯一 ID。 |
示例值示例值示例值 |
| ChannelType |
string |
通道类型。 |
示例值示例值示例值 |
| MessageId |
string |
消息 ID。 |
示例值 |
| Code |
string |
请求状态码。
|
示例值示例值示例值 |
| Success |
boolean |
是否调用成功。
|
false |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "无",
"Message": "示例值",
"RequestId": "示例值",
"Data": [
{
"ConversationId": "示例值示例值",
"BusinessNumber": "示例值示例值",
"ClientAcceptStatusName": "示例值示例值示例值",
"Message": "示例值示例值",
"MessageTypeName": "示例值示例值",
"FailReason": "示例值示例值",
"EventActionName": "示例值",
"Month": "示例值示例值",
"LanguageCode": "示例值示例值",
"TemplateName": "示例值示例值",
"MessageType": "示例值示例值",
"SendTime": "示例值示例值",
"MessageStatusName": "示例值",
"ClientReadStatus": "示例值示例值",
"MessageSource": "示例值示例值",
"FailBackFlag": "Y",
"UserNumber": "示例值示例值示例值",
"TemplateCode": "示例值示例值",
"MessageStatus": "示例值示例值",
"Type": "示例值示例值",
"FailBackContent": "示例值",
"EventAction": "示例值示例值",
"ClientReadStatusName": "示例值示例值",
"UniqueMessageId": "示例值示例值示例值",
"ChannelType": "示例值示例值示例值",
"MessageId": "示例值"
}
],
"Code": "示例值示例值示例值",
"Success": false
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。