云服务器内容精选

  • 请求参数 表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参数,状态报告就不会携带该参数。
  • 请求示例 定义短信回执。租户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}