文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息基础版发送/ 查询智能信息基础版发送任务
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

查询智能信息基础版发送任务

功能介绍

支持用户根据过滤条件查询智能信息基础版任务列表。包括：发送任务名称、智能信息基础版模板ID等。

URI

GET /v1/aim-basic/send-tasks

表1 Query参数

参数

是否必选

参数类型

描述

task_name

否

String

智能信息基础版任务名称。

task_id

否

String

智能信息基础版任务ID。

tpl_id

否

String

智能信息基础版模板ID。

tpl_name

否

String

智能信息基础版模板名称。

begin_time

否

String

智能信息基础版任务创建开始时间。 样例为：2019-10-12T07:20:50Z。

end_time

否

String

智能信息基础版任务创建结束时间。 样例为：2019-10-12T07:20:50Z。

send_begin_time

否

String

智能信息基础版任务发送开始时间。 样例为：2019-10-12T07:20:50Z。

send_end_time

否

String

智能信息基础版任务发送结束时间。 样例为：2019-10-12T07:20:50Z。

operator

否

String

操作员。

task_status

否

String

发送状态类型。

  • submit_success：提交成功

  • submit_failed：提交失败

  • processing：发送中

  • sending_failed：发送失败

  • re_submit_success：重试提交成功

  • sending_complete：发送完成

  • re_submit_failed：重试提交成功

  • re_processing：重试进行中

  • re_sending_complete：重试发送完成

  • scheduled：定时任务

offset

否

Integer

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

最小值：0

最大值：2147483647

缺省值：0

limit

否

Integer

每页显示的条目数量。

最小值：1

最大值：100

缺省值：20

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态，固定200。

message

String

状态描述。

data

VMSSendTasks object

查询智能信息基础版发送任务列表响应。
表4 VMSSendTasks

参数

参数类型

描述

aim_basic_send_tasks

Array of VMSSendBody objects

智能信息基础版任务查询列表。

数组长度：0 - 100

page_info

Page object

分页信息。
表5 VMSSendBody

参数

参数类型

描述

task_id

String

智能信息基础版任务ID。

task_name

String

智能信息基础版任务名称。

task_state

String

智能信息基础版任务状态。

tpl_id

String

智能信息基础版模板ID。

tpl_name

String

智能信息基础版模板名称。

operator

String

操作员。

create_time

String

智能信息基础版任务创建时间。

send_time

String

智能信息基础版任务发送时间。

total_count

Integer

需要发送的手机号码总数（有效号码总数）。

success_count

Integer

已经发送成功的手机号码总数。

failed_count

Integer

已经发送失败的手机号码总数。

timeout_count

Integer

已经发送超时失败的手机号码总数（72小时没接收到状态认定为超时失败）。

exdata

String

扩展字段。

说明：

预留字段。
表6 Page

参数

参数类型

描述

offset

Integer

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

limit

Integer

每页显示的条目数量。

total

Integer

总条数。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

请求示例

查询智能信息基础版发送任务

https://koomessage.myhuaweicloud.cn/v1/aim-basic/send-tasks?task_name&task_id

响应示例

状态码： 200

查询智能信息基础版任务列表返回体。

{
  "status" : "200",
  "message" : "success",
  "data" : {
    "aim_basic_send_tasks" : [ {
      "task_id" : "dcda9636-b30f-473c-af88-c8ea2ccccccc",
      "task_name" : "回落",
      "task_state" : "发送中",
      "tpl_id" : "800000003",
      "tpl_name" : "测试-年中福利",
      "operator" : "hwstaff_KMSG_Customer2",
      "create_time" : "2022-06-07T01:00:15Z",
      "send_time" : "2022-06-07T01:00:15Z",
      "total_count" : 1,
      "success_count" : 0,
      "failed_count" : null,
      "timeout_count" : null,
      "exdata" : null
    }, {
      "task_id" : "975d83c2-8b26-4a98-b758-76b88efccccc",
      "task_name" : "0606ceshi003",
      "task_state" : "发送完成",
      "tpl_id" : "800000004",
      "tpl_name" : "测试-华为云产品欢迎您",
      "operator" : "hwstaff_KMSG_Customer2",
      "create_time" : "2022-06-06T02:02:23Z",
      "send_time" : "2022-06-06T02:02:23Z",
      "total_count" : 3,
      "success_count" : 3,
      "failed_count" : null,
      "timeout_count" : null,
      "exdata" : null
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 2,
      "total" : 27
    }
  }
}

状态码

状态码

描述

200

查询智能信息基础版任务列表返回体。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

相关文档