更新时间:2023-08-21 GMT+08:00
分享

定义智能信息发送回执

功能介绍

用户按接口定义实现智能信息发送回执接口。

用户每次发送智能信息时,将接收到最新的状态上报。发送智能信息无论成功或失败都会上报callback_type为sms的回执;只有解析成功才会上报callback_type为shortchain的回执。

响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。

URI

POST /v1/aim/send-status

请求参数

表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
    }

响应示例

状态码

状态码

描述

200

返回信息。

错误码

请参见错误码

分享:

    相关文档

    相关产品