文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息解析/ 查询解析明细
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

查询解析明细

功能介绍

根据用户提供的过滤条件查询个性化解析明细，包括：发送任务ID、发送手机号码等。

URI

GET /v1/aim/resolve-details

表1 Query参数

参数

是否必选

参数类型

描述

task_id

否

String

解析任务ID或者发送任务ID。

最小长度：0

最大长度：36

task_name

否

String

任务名称。

最小长度：0

最大长度：30

tpl_id

否

String

智能信息模板ID。

最小长度：0

最大长度：9

tpl_name

否

String

智能信息模板名称。

cust_flag

否

String

创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。

最小长度：0

最大长度：64

sms_sign

否

String

签名。

最小长度：0

最大长度：18

aim_url

否

String

智能信息短链，通过自己的短信渠道发送时，需要把该短链添加到短信模板中，并确保发送短信时的签名与创建短链时的签名保持一致。

最小长度：0

最大长度：100

resolved_status

否

String

解析状态。

  • success：解析成功

  • fail：解析失败

  • unresolved：未解析

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：0

最大长度：2000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

resolve_details

Array of AIMResolveDetail objects

查询解析结果集。

page_info

Page object

分页信息。
表4 AIMResolveDetail

参数

参数类型

描述

resolve_id

String

解析详情唯一标识ID。

task_id

String

任务ID。

task_name

String

任务名称。

send_account

String

发送的用户名。

tpl_id

String

智能信息模板ID。

tpl_name

String

智能信息模板名称。

cust_flag

String

创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。

aim_url

String

智能信息短链，通过自己的短信渠道发送时，需要把该短链添加到短信模板中，并确保发送短信时的签名与创建短链时的签名保持一致。

result_code

String

短链申请结果返回码。

  • 0：成功

  • 非0：失败，具体请参见错误码。

generate_date

String

短链生成时间。样例为：2019-10-12T07:20:50Z。

expire_date

String

短链到期时间。样例为：2019-10-12T07:20:50Z。

resolved_time

String

解析时间。样例为：2019-10-12T07:20:50Z。

resolved_status

String

解析状态。

  • success：解析成功

  • fail：解析失败

  • unresolved：未解析
表5 Page

参数

参数类型

描述

offset

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

limit

Integer

每页显示的条目数量。

total

Integer

总条数。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明：

该字段在以后可能会废弃，建议使用error_msg字段对接。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明：

该字段在以后可能会废弃，建议使用error_msg字段对接。

请求示例

根据模板ID查询解析任务明细。

https://koomessage.myhuaweicloud.cn/v1/aim/resolve-details?tpl_id=606425661&offset=0&limit=1

响应示例

状态码： 200

返回信息。

{
  "resolve_details" : [ {
    "resolve_id" : "29ae28ea-0300-4da1-8e54-6c91319fcccc",
    "task_id" : "bf04fc77-12c8-408f-a584-cf3d3e91cccc",
    "task_name" : "ZF2",
    "send_account" : "myaccount",
    "tpl_id" : "600000001",
    "tpl_name" : "【测试】参数通知模板",
    "cust_flag" : "131****0000",
    "aim_url" : "km2g.cn/MzNkNP",
    "result_code" : "0",
    "generate_date" : "2022-07-19T08:44:04Z",
    "expire_date" : "2022-07-26T08:44:04Z",
    "resolved_time" : "2022-07-19T08:44:31Z",
    "resolved_status" : "success"
  } ],
  "page_info" : {
    "offset" : 0,
    "limit" : 1,
    "total" : 18
  }
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 智能信息解析

相关文档