查询智能信息发送明细
功能介绍
根据用户提供的过滤条件查询发送明细列表，包括：发送任务ID、发送手机号码等。
URI
GET /v1/aim/send-details
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
否 |
String |
任务ID。 最小长度：0 最大长度：36 |
|
tpl_id |
否 |
String |
智能信息模板ID。 最小长度：0 最大长度：9 |
|
sms_sign |
否 |
String |
签名。 最小长度：0 最大长度：18 |
|
cust_flag |
否 |
String |
创建解析任务时填写用户唯一标识。
说明：
手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。 最小长度：0 最大长度：64 |
|
begin_time |
否 |
String |
发送开始时间。格式为：2019-10-12T07:20:50Z。
说明：
需同时传入end_time才能生效，单独传begin_time不会作为过滤条件。 仅支持查询最近1年内的发送明细。 最小长度：0 最大长度：30 |
|
end_time |
否 |
String |
发送结束时间。格式为：2019-10-12T07:20:50Z。
说明：
需同时传入begin_time才能生效，单独传end_time不会作为过滤条件。 最小长度：0 最大长度：30 |
|
offset |
是 |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0。
说明：
为提高查询效率，offset+limit须小于等于10000，超出范围查询为空。 最小值：0 最大值：1000000 |
|
limit |
是 |
Integer |
每页显示的条目数量。 最小值：1 最大值：100 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
send_details |
Array of AIMMsgSendDetail objects |
查询发送明细结果集。 |
|
page_info |
Page object |
分页信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
msg_id |
String |
发送明细的唯一标识ID。 |
|
task_id |
String |
任务ID。 |
|
task_name |
String |
任务名称。 |
|
tpl_id |
String |
智能信息模板ID。 |
|
tpl_name |
String |
智能信息模板名称。 |
|
cust_flag |
String |
创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。 |
|
send_account |
String |
发送的目标手机号。 |
|
send_status |
String |
发送状态。
|
|
send_time |
String |
发送时间。 |
|
receive_time |
String |
接收时间。 |
|
result_code |
String |
发送错误码。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0。 |
|
limit |
Integer |
每页显示的条目数量。 |
|
total |
Integer |
总条数。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 |
|
error_msg |
String |
结果详情。 |
|
error_message |
Object |
结果详情。
说明：
该字段在以后可能会废弃，建议使用error_msg字段对接。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 |
|
error_msg |
String |
结果详情。 |
|
error_message |
Object |
结果详情。
说明：
该字段在以后可能会废弃，建议使用error_msg字段对接。 |
请求示例
根据发送任务ID查询智能信息发送明细。
https://koomessage.myhuaweicloud.cn/v1/aim/send-details?task_id=7cc198c3-91d3-425b-9226-54c27cd7cccc&offset=0&limit=2
响应示例
状态码： 200
返回信息。
{
"send_details" : [ {
"msg_id" : "7e52e4fe-ef00-4826-84b6-756446c5cccc_595223901",
"task_id" : "7cc198c3-91d3-425b-9226-54c27cd7cccc",
"task_name" : "智能信息发送-动态参数",
"tpl_id" : "600000001",
"tpl_name" : "【测试市场案例】参数通知模板",
"cust_flag" : "131****0000",
"send_account" : "131****0000",
"send_status" : "success",
"send_time" : "2022-07-19T14:57:20Z",
"receive_time" : "2022-07-19T14:57:31Z",
"result_code" : null
}, {
"msg_id" : "7e52e4fe-ef00-4826-84b6-756446c5cccc_595223902",
"task_id" : "7cc198c3-91d3-425b-9226-54c27cd7cccc",
"task_name" : "智能信息发送-动态参数",
"tpl_id" : "600000001",
"tpl_name" : "【测试市场案例】参数通知模板",
"cust_flag" : "131****0001",
"send_account" : "131****0001",
"send_status" : "success",
"send_time" : "2022-07-19T14:57:20Z",
"receive_time" : "2022-07-19T14:57:30Z",
"result_code" : null
} ],
"page_info" : {
"offset" : 0,
"limit" : 2,
"total" : 2
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回信息。 |
|
400 |
非法参数。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
