# 查询智能信息发送任务 #### 功能介绍 根据用户提供的过滤条件查询智能信息发送任务列表，包括：发送任务名称、智能信息模板ID等。 #### URI GET /v1/aim/send-tasks 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 否 | String | 智能信息发送任务ID。 | | task_name | 否 | String | 智能信息发送任务名称。 最小长度：**0** 最大长度：**20** | | tpl_id | 否 | String | 智能信息模板ID。 最小长度：**0** 最大长度：**9** | | tpl_name | 否 | String | 智能信息模板名称。 最小长度：**0** 最大长度：**100** | | begin_time | 否 | String | 智能信息发送任务创建开始时间。样例：2019-10-12T07:20:50.522Z。 说明： 需同时传入end_time才能生效，单独传begin_time不会作为过滤条件。缺省：查询最近7天（168小时）数据。 仅支持查询最近1年内创建的智能信息发送任务。 | | end_time | 否 | String | 智能信息发送任务创建结束时间。样例：2019-10-12T07:20:50.522Z。 说明： 需同时传入begin_time才能生效，单独传end_time不会作为过滤条件。缺省：查询最近7天（168小时）数据。 | | task_status | 否 | String | 智能信息发送任务状态。 - Success：创建成功 - Fail：创建失败 | | 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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | aim_send_tasks | Array of [ListAIMSendTaskParam] objects | 短信记录查询结果列表。 | | page_info | [Page] object | 分页信息。 | 表4ListAIMSendTaskParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_name | String | 智能信息发送任务名称。 | | sms_channel | [ListAIMSendTaskSmsChannel] object | 查询智能信息发送任务响应体。 | | resolve_task | [ListAIMSendTaskResolve] object | 短链生成配置。 说明： 预留字段，暂时为空。 | | task_id | String | 任务ID。 | | task_state | String | 任务状态。 - Success：发送成功 - Failed：发送失败 说明： 此状态仅代表任务提交状态，不代表智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准，也可通过查询智能信息发送明细API获取或登录KooMessage控制台查看。 | | creation_time | String | 创建时间。样例：2019-10-12T07:20:50.522Z。 | | submission_count | Integer | 提交的手机号码总数。 | | send_count | Integer | 发送数量。 | | resolve_count | Integer | 智能信息解析成功的手机号码总数。 | | support_resolve_count | Integer | 支持智能信息解析的手机号码总数。 说明： 通过API发送的智能信息任务不做解析能力判断，返回-1作为标识。 | | failed_short_chains | Array of [CreateResolveTaskResultParam] objects | 短链生成失败列表。 说明： 预留字段。 | | success_number | Integer | 发送成功的智能信息数。 | 表5ListAIMSendTaskSmsChannel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | channel_number | String | 短信通道号。 说明： 预留字段，暂时为空。 | | sms_tpl_id | String | 短信模板ID。 | | sms_sign | String | 短信签名。 | | sms_app_name | String | 短信应用名称。 说明： 预留字段，暂时为空。 | 表6ListAIMSendTaskResolve | 参数 | 参数类型 | 描述 | |:---|:---|:---| | tpl_id | String | 智能信息模板ID，由9位数字组成。 | | resolve_times | Integer | 短链的最大解析次数。 | | aim_code_type | String | 智能信息编码类型。 - group：群发 - individual：个性化 | | domain | String | 自定义短链域名，样例：km2g.cn、km2g.cn/a1、km2g.cn/a1/b2。 说明： - 自定义短码即generation_type为2时，此参数为必填，域名需要提前申请。 - 域名申请支持单独域名申请，也支持域名加路径申请，最多支持两层路径。 最大长度：**100** | | expiration_time | Integer | 失效时间（天）。 | | params | Array of [ResolveTaskParam] objects | 短链解析详情列表。一次请求最多100个短链。 | 表7ResolveTaskParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cust_flag | String | 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。 发送智能信息时则必须填客户的手机号码。样例为：130\*\*\*\*0001。 | | dync_params | Map\ | 动态参数。 说明： 使用动态参数模板时，aim_code_type字段只能为individual。 | | custom_url | String | 自定义跳转地址。长度要求不超过2048。 说明： - 未填时，终端用户点击短信原文中的短链后，跳转智能信息模板H5页 - 已填时，终端用户点击短信原文中的短链后，跳转该字段对应的页面，填写时必须为http或https作为前缀 - 使用自定义跳转链接功能请联系KooMessage运营人员进行域名备案 | 表8CreateResolveTaskResultParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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:50Z。 | | expire_date | String | 短链到期时间。样例为：2019-10-12T07:20:50Z。 | | resolved_date | String | 解析时间。样例为：2019-10-12T07:20:50Z。 说明： 预留字段。 | | resolved_times | Integer | 短链实际解析次数。 说明： 预留字段。 | | custom_short_code | String | 自定义短码，支持长度为3到10位的数字或大小写字母。样例为：aDC123。 | 表9Page | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 | | limit | Integer | 每页显示的条目数量。 | | total | Integer | 总条数。 | **状态码： 400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 结果状态码。 | | error_msg | String | 结果详情。 | | error_message | AnyType | 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 | **状态码： 500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 结果状态码。 | | error_msg | String | 结果详情。 | | error_message | AnyType | 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 | #### 请求示例 查询智能信息发送任务。 ``` https://koomessage.myhuaweicloud.com/v1/aim/send-tasks?offset=0&limit=2 ``` #### 响应示例 **状态码： 200** 返回信息。 ``` { "aim_send_tasks" : [ { "task_id" : "7cc198c3-91d3-425b-9226-54c27cd7cccc", "task_name" : "智能信息发送-动态参数", "task_state" : "Success", "submission_count" : 2, "send_count" : 2, "resolve_count" : 1, "support_resolve_count" : -1, "sms_channel" : { "sms_sign" : "华为云KooMessage" }, "creation_time" : "2022-07-19T14:57:20.00Z", "failed_short_chains" : null, "success_number" : 1 } ], "page_info" : { "offset" : 0, "limit" : 2, "total" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 返回信息。 | | 400 | 非法参数。 | | 500 | 内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koomessage/ErrorCode.html)。