# 查询解析任务 #### 功能介绍 创建解析任务后，客户可以查询解析任务状态信息。 通过模板ID等过滤条件，查询解析任务列表。 如需查询明细，建议使用查询解析明细接口。 #### URI GET /v1/aim/resolve-tasks 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 否 | String | 解析任务ID。 最小长度：**0** 最大长度：**36** | | task_name | 否 | String | 任务名称。 最小长度：**0** 最大长度：**30** | | tpl_id | 否 | String | 智能信息模板ID。 最小长度：**0** 最大长度：**9** | | tpl_name | 否 | String | 智能信息模板名称。 最小长度：**0** 最大长度：**100** | | cust_flag | 否 | String | 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。 发送智能信息时则必须填客户的手机号码。样例为：130\*\*\*\*0001。 最小长度：**0** 最大长度：**100** | | aim_url | 否 | String | 完整的短链连接地址。样例：km2g.cn/PDiWqc。 | | begin_time | 否 | String | 智能信息解析任务创建开始时间。格式为：2019-10-12T07:20:50.522Z。 说明： 需同时传入end_time才能生效，单独传begin_time不会作为过滤条件。 若不填，则默认查询24小时内创建的解析任务。 仅支持查询最近1年内创建的解析任务。 最小长度：**0** 最大长度：**30** | | end_time | 否 | String | 智能信息解析任务创建结束时间。格式为：2019-10-12T07:20:50.522Z。 说明： 需同时传入begin_time才能生效，单独传end_time不会作为过滤条件。 若不填，则默认查询24小时内创建的解析任务。 | | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 说明： 为提高查询效率，offset+limit须小于等于10000，超出范围查询为空。 最小值：**0** 最大值：**1000000** 缺省值：**0** | | limit | 否 | Integer | 每页显示的条目数量。 最小值：**1** 最大值：**100** 缺省值：**20** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resolve_tasks | Array of [ListResolveTaskResult] objects | 解析任务列表。 | | page_info | [Page] object | 分页信息。 | 表4ListResolveTaskResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | 任务ID。 | | task_name | String | 任务名称。 | | tpl_id | String | 智能信息模板ID，由9位数字组成。 | | sms_signs | Array of strings | 短信签名列表。 | | resolving_times | Integer | 用户创建时提交的最大解析次数。 | | resolved_times | Integer | 实际已解析数量统计。 | | aim_code_type | String | 智能信息编码类型。 - group：群发 - individual：个性化 | | domain | String | 自定义短链域名，样例：km2g.cn、km2g.cn/a1、km2g.cn/a1/b2。 | | expiration_time | Integer | 失效时间（天）。 | | params | Array of [ListResolveTaskResultParam] objects | 短链列表。该列表中只会有一条短链记录，如果一个任务中生成多个短链，则需要客户端基于任务ID（task_id）自己去合并。 说明： 建议使用查询解析明细接口查询此字段信息，未来版本有计划移除该字段。 | 表5ListResolveTaskResultParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cust_flag | String | 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。 发送智能信息时则必须填客户的手机号码。样例为：130\*\*\*\*0001。 | | cust_id | String | 租户ID。 | | dync_params | Map\ | 动态参数。 | | custom_url | String | 自定义跳转地址。 说明： - 未填时，终端用户点击访问短信原文中的短链，跳转智能信息H5页 - 已填时，终端用户点击访问短信原文中的短链，跳转客户填写的链接落地页，填写时必须为http或https作为前缀 | | aim_url | String | 完整的短链连接地址，通过自己的短信渠道发送时，需要把该短链添加到短信模板中，并确保发送短信时的签名与创建短链时的签名保持一致。样例：km2g.cn/PDiWqc。 | | aim_code | String | 智能信息编码。样例：PDiWqc。 | | ext_data | String | 自定义扩展参数。 说明： 预留字段。 | | result_code | String | 短链申请结果返回码。 - 0：成功 - 非0：失败，具体请参见错误码 | | error_message | String | 短链申请结果错误描述。 | | generate_date | String | 短链生成时间。样例为：2019-10-12T07:20:50。 | | expire_date | String | 短链到期时间。样例为：2019-10-12T07:20:50。 | | resolved_date | String | 解析时间。样例为：2019-10-12T07:20:50。 | | resolved_times | Integer | 短链实际解析次数。 说明： 预留字段。 | 表6Page | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 | | limit | Integer | 每页显示的条目数量。 | | total | Integer | 总条数。 | **状态码： 400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 结果状态码。 | | error_msg | String | 结果详情。 | | error_message | AnyType | 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 | **状态码： 500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 结果状态码。 | | error_msg | String | 结果详情。 | | error_message | AnyType | 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 | #### 请求示例 查询所有解析任务 ``` https://koomessage.myhuaweicloud.com/v1/aim/resolve-tasks?offset=0&limit=2 ``` #### 响应示例 **状态码： 200** 返回信息。 ``` { "resolve_tasks" : [ { "task_id" : "30d6db9b-cc8a-4dc9-a314-d80d3fd0dbea", "task_name" : "ZF2", "tpl_id" : "600000001", "sms_signs" : [ "华为云KooMessage" ], "resolving_times" : 1, "resolved_times" : 1, "aim_code_type" : "individual", "domain" : "km2g.cn", "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0001", "cust_id" : "231724915a62455ca356e10a085ccccc", "dync_params" : { "param3" : "参数3", "param4" : "参数4", "param1" : "参数1", "param2" : "参数2" }, "custom_url" : "https://www.example.com", "aim_url" : "km2g.cn/PDiWqc", "aim_code" : "PDiWqc", "result_code" : "0", "error_message" : "-", "generate_date" : "2022-07-18T21:00:56", "expire_date" : "2022-07-25T21:00:56", "resolved_date" : "2022-07-21T11:43:00" } ] }, { "task_id" : "30d6db9b-cc8a-4dc9-a314-d80d3fd0dbea", "task_name" : "ZFJ1", "tpl_id" : "600000001", "sms_signs" : [ "华为云KooMessage" ], "resolving_times" : 1, "resolved_times" : 0, "aim_code_type" : "individual", "domain" : "km2g.cn", "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0000", "cust_id" : "231724915a62455ca356e10a085ccccc", "dync_params" : { "param3" : "参数3", "param4" : "参数4", "param1" : "参数1", "param2" : "参数2" }, "custom_url" : "https://www.example.com", "aim_url" : "km2g.cn/PDeag3", "aim_code" : "PDeag3", "result_code" : "0", "error_message" : "-", "generate_date" : "2022-07-18T21:00:56", "expire_date" : "2022-07-25T21:00:56", "resolved_date" : null } ] } ], "page_info" : { "offset" : 0, "limit" : 2, "total" : 80 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 返回信息。 | | 400 | 非法参数。 | | 500 | 内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koomessage/ErrorCode.html)。