云消息服务 KOOMESSAGE-华为云

云消息服务 KOOMESSAGE-查询短信应用:响应示例

响应示例状态码： 200 查询短信应用响应体。 { "result" : [ { "status" : "LAUNCHED", "region" : "cn", "app_id" : "2353cb25-c169-4e20-adcf-****7b4e0f9e", "app_name" : "AAAAA", "up_link_addr" : "https://www.huaweicloud.com/sms/receive", "create_time" : "2023-08-07T02:21:26" } ], "page_info" : { "offset" : 0, "limit" : 2, "total" : 1 } }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-查询短信应用:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 result Array of SmsApp objects 查询结果。 page_info Page object 分页信息。表4 SmsApp 参数参数类型描述 app_id String 应用ID，用于获取、修改应用的唯一标识。最小长度：1 最大长度：50 app_name String 应用名称。最小长度：1 最大长度：30 status String 状态。最小长度：1 最大长度：20 枚举值： CREATED：待上线。应用暂未创建成功，请稍候 SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停 LAUNCHED：正常。应用添加成功，可以正常使用 region String 地域。最小长度：1 最大长度：20 create_time String 创建时间，格式：yyyy-MM-dd'T'HH:mm:ss。最小长度：1 最大长度：20 up_link_addr String 上行短信地址。最小长度：1 最大长度：255 表5 Page 参数参数类型描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 结果状态码。最小长度：0 最大长度：32 error_msg String 结果详情。最小长度：0 最大长度：32 状态码： 500 表7 响应Body参数参数参数类型描述 error_code String 结果状态码。最小长度：0 最大长度：32 error_msg String 结果详情。最小长度：0 最大长度：32

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-查询短信应用:URI

URI GET /v1/sms/apps 表1 Query参数参数是否必选参数类型描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。缺省值：0 limit 否 Integer 每页显示的条目数量。缺省值：10 app_name 否 String 应用名称。最小长度：1 最大长度：30 status 否 String 应用状态。 begin_time 否 String 创建时间筛选-开始时间。格式为：2019-10-12T07:20:50Z。 end_time 否 String 创建时间筛选-结束时间。格式为：2019-10-12T07:20:50Z。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-定义智能信息发送回执:请求示例

请求示例定义短信回执。租户ID为"8f263a05a2294c62af09cfeccbd1cccc"，回执类型为"sms"。 https://koomessage.myhuaweicloud.cn/v1/aim/send-status { "request_id" : "6b65e1ae-3e6e-45d3-8aab-05821b540000", "domain_id" : "8f263a05a2294c62af09cfeccbd1cccc", "callback_type" : "sms", "body" : "{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"msg_id\":\"e0ef4e00-xxxx-xxxx-ba33-4173156e657f\",\"tpl_id\":\"600000001\",\"sms_sign\":\"签名\",\"aim_code\":\"qTs3DC\",\"aim_url\":\"km2n.cn/qTB3DC\",\"send_time\":\"2022-06-01T09:00:49\",\"receive_time\":\"2022-06-01T09:00:49\",\"send_status\":\"Deliverd\",\"send_status_desc\":\"发送成功\"}", "retry" : false } 定义短信批量回执。租户ID为"8f263a05a2294c62af09cfeccbd1cccc"，回执类型为"sms"。 https://koomessage.myhuaweicloud.cn/v1/aim/send-status { "request_id" : "6b65e1ae-3e6e-45d3-8aab-05821b39j313", "domain_id" : "8f263a06a2294c62af09cfeccbd1cccc", "callback_type" : "sms", "body" : "[{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"msg_id\":\"e0ef4e00-xxxx-xxxx-ba33-4173156e657f\",\"tpl_id\":\"600000001\",\"sms_sign\":\"签名\",\"aim_code\":\"qTs3DC\",\"aim_url\":\"km2n.cn/qTB3DC\",\"send_time\":\"2022-06-01T09:00:49\",\"receive_time\":\"2022-06-01T09:00:49\",\"send_status\":\"Deliverd\",\"send_status_desc\":\"发送成功\"}]", "retry" : false } 定义短链回执。租户ID为"8f263a06a2294c62af09cfeccbd1cccc"，回执类型为"shortchain"。 https://koomessage.myhuaweicloud.cn/v1/send-status { "request_id" : "6b65e1ae-3e6e-44d3-8aab-05821b540000", "domain_id" : "8f263a06a2294c62af09cfeccbd1cccc", "callback_type" : "shortchain", "body" : "{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"tpl_id\":\"600000001\",\"aim_url\":\"km2n.cn/qTB3DC\",\"aim_code\":\"qTs3DC\",\"status\":0,\"describe\":\"发送成功\"}", "retry" : false } 定义短链批量回执。租户ID为"8f263a06a2294c62af09cfeccbd1cccc"，回执类型为"shortchain"。 https://koomessage.myhuaweicloud.cn/v1/send-status { "request_id" : "6b65e1ae-3e6e-44d3-8aab-05821b540000", "domain_id" : "8f263a06a2294c62af09cfeccbd1cccc", "callback_type" : "shortchain", "body" : "[{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"tpl_id\":\"600000001\",\"aim_url\":\"km2n.cn/qTB3DC\",\"aim_code\":\"qTs3DC\",\"status\":0,\"describe\":\"发送成功\"}]", "retry" : false }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-定义智能信息发送回执:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。表2 请求Body参数参数是否必选参数类型描述 request_id 否 String 请求ID。最小长度：0 最大长度：100 domain_id 否 String 租户ID。最小长度：0 最大长度：100 callback_type 否 String 回调类型。 shortchain：短链 sms：短信最小值：1 最大值：2 body 否 String 响应信息。回调类型为智能信息单条发送/短链回调： callback_type为shortchain时，body为ShortChainCallback实体的json字符串。 callback_type为sms时，body为SmsCallback实体的json字符串。回调类型为智能信息批量发送/短链回调： callback_type为shortchain时，body为ShortChainCallback实体数组的json字符串。 callback_type为sms时，body为SmsCallback实体数组的json字符串。说明：回执中的task_id可用于发送任务或解析任务关联，使用发送智能信息API发送智能短信，同一发送批次每一个手机号最多收到两次回执，一个发送结果回执，一个解析成功回执，两次回执可使用aim_url关联。最小长度：0 最大长度：100 retry 否 Boolean 重试标识。表3 ShortChainCallback 参数是否必选参数类型描述 task_id 否 String 任务ID。 cust_flag 否 String 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。 tpl_id 否 String 智能信息模板ID，由9位数字组成。 aim_url 否 String 带URL地址的智能信息短链。 aim_code 否 String 不带URL地址前缀的智能信息编码。 status 否 Integer 生成状态。 0：成功非0：失败，具体请参见错误码 describe 否 String 对应返回的回执错误码的描述内容。表4 SmsCallback 参数是否必选参数类型描述 task_id 否 String 任务ID。 cust_flag 否 String 客户ID。 msg_id 否 String 发送明细的唯一标识ID。 tpl_id 否 String 智能信息模板ID，由9位数字组成。 sms_sign 否 String 短信签名。 aim_code 否 String 不带URL地址前缀的智能信息编码。 aim_url 否 String 带URL地址的智能信息短链。 send_time 否 String 短信发送时间。 receive_time 否 String 短信接收时间。 send_status 否 String 发送状态码。说明： “DELIVRD”代表短信发送成功，其余状态码请参考短信服务错误码表。 send_status_desc 否 String 发送状态描述。 total 否 String 长短信拆分后的短信条数。当短信未拆分时该参数取值为1。 sequence 否 String 长短信拆分后的短信序号。当total参数取值大于1时，该参数才有效。当短信未拆分时该参数取值为1。 extend 否 String 扩展字段。用户可以在发送短信的请求中携带该参数，如果用户发送短信时未携带extend参数，状态报告就不会携带该参数。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-发送短信:请求示例

请求示例向用户发送短信，短信通道号为882306039，模板ID为1512。 https://koomessage.myhuaweicloud.cn/v1/aim/sms/messages { "channel_num" : "8823060****39", "template_id" : "1512****", "signature" : "测试签名", "app_name" : "OPACCOUNT688", "task_name" : "测试发送", "to" : [ "139274****98", "15527****78" ], "template_params" : [ "kXfvIwzs" ] }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-发送短信:响应示例

响应示例状态码： 200 发送短信响应体。 { "status" : "Success", "result" : [ { "to" : "+86139274****8", "channel_num" : "8823060****9", "msg_id" : "b24f1f03-556e-468e-9fe1-23729b9414d7_72****6", "create_time" : "2023-08-11T12:11:24", "send_status" : "000000" }, { "to" : "+861552****978", "channel_num" : "8823060806439", "msg_id" : "b24f1f03-556e-468e-9fe1-23729b9414d7_****407", "create_time" : "2023-08-11T12:11:24", "send_status" : "000000" } ], "task_id" : "a914ca57-09cf-4899-af62-f9a****06c3c" }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-发送短信:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 task_id String 任务ID。最小长度：1 最大长度：50 status String 任务状态。 Success：发送成功 Failed：发送失败说明：此状态仅代表任务提交状态，不代表智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准，也可通过查询智能信息发送明细API获取或登录 KooMessage 控制台查看。最小长度：1 最大长度：20 result Array of SmsDetailResponse objects 短信ID列表，当目标号码存在多个时，每个号码都会返回一个SmsID。当返回异常响应时不携带此字段。表4 SmsDetailResponse 参数参数类型描述 to String 短信接收方的号码。最小长度：1 最大长度：21 channel_num String 短信发送方的号码。最小长度：1 最大长度：21 msg_id String 短信的唯一标识。最小长度：1 最大长度：50 send_status String 短信状态码。以下举例状态码及其说明，具体处理建议请参考API错误码。 000000：短信平台处理请求成功 E200015：待发送短信数量太大 E200028：模板变量校验失败 E200029：模板类型校验失败 E200030：模板未激活 E200031：协议校验失败 E200033：模板类型不正确 E200041：同一短信内容接收号码重复最小长度：1 最大长度：7 create_time String 短信资源的创建时间。即短信平台接收到用户发送短信请求的时间，为UTC时间。格式为：yyyy-MM-dd'T'HH:mm:ss'Z'。最小长度：1 最大长度：20 状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 结果状态码。最小长度：0 最大长度：32 error_msg String 结果详情。最小长度：0 最大长度：32 状态码： 500 表6 响应Body参数参数参数类型描述 error_code String 结果状态码。最小长度：0 最大长度：32 error_msg String 结果详情。最小长度：0 最大长度：32

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-删除模板实例:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 status String 请求状态，固定200。 message String 状态描述。 data Object 固定为null。状态码： 400 表4 响应Body参数参数参数类型描述 error_code String 结果状态码。 error_msg String 结果详情。状态码： 500 表5 响应Body参数参数参数类型描述 error_code String 结果状态码。 error_msg String 结果详情。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-查询智能信息基础版发送任务:响应示例

响应示例状态码： 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 } } }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-查询智能信息基础版发送任务:响应参数

响应参数状态码： 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 结果详情。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-查询智能信息基础版发送任务:URI

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

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-创建短信应用:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。表2 请求Body参数参数是否必选参数类型描述 app_name 是 String 应用名称。最小长度：1 最大长度：30 up_link_addr 否 String 上行回调地址。支持通信协议HTTPS/HTTP。最大长度：255

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-创建短信应用:请求示例

请求示例创建一个名称为Huawei_12688，上行回调地址为https://www.huaweicloud.com/的短信应用。 https://koomessage.myhuaweicloud.cn/v1/sms/apps { "app_name" : "Huawei_12688", "up_link_addr" : "https://www.huaweicloud.com/" }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-创建短信应用:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 app_name String 应用名称。最小长度：1 最大长度：30 app_id String 应用ID。最小长度：1 最大长度：50 状态码： 400 表4 响应Body参数参数参数类型描述 error_code String 结果状态码。最小长度：0 最大长度：32 error_msg String 结果详情。最小长度：0 最大长度：32 状态码： 500 表5 响应Body参数参数参数类型描述 error_code String 结果状态码。最小长度：0 最大长度：32 error_msg String 结果详情。最小长度：0 最大长度：32

云消息服务 KOOMESSAGE

云服务器内容精选

云消息服务 KOOMESSAGE

7*24

备案

专业服务

退订

建议反馈

售前咨询热线