文档

SmsReport - 回执接口定义

更新时间:

短信发送状态报告接口定义。

接口说明

您可以指定 HTTP URL 来接收由短信服务推送的短信发送状态报告,然后 SmsReport 使用 HTTP 服务接收消息传递报告。 您可以使用 UpdateReportUrl 更新您的接收服务 URL。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v2/recall/report

请求参数

名称类型必填描述示例值
bodyobject []

请求参数的主体信息。

biz_idstring

发送回执 ID,即发送流水号。

12345
err_codestring

状态报告编码。

DELIVERED
err_msgstring

状态报告说明。

用户接收成功
message_idstring

短信 ID。调用发送接口 SendMessage 发送短信时,返回值中的 ID 字段。可使用短信 ID 在接口 ListMessages 查询具体的发送状态。

123
out_idstring

外部拓展字段。

123
phone_numberstring

手机号码。

1390000****
report_timestring

状态报告时间。

2017-09-01 00:00:00
request_idstring

短信批处理 ID。调用发送接口 SendMessage 发送短信时,返回值中的 RequestId 字段。可使用短信批处理 ID 在接口 ListMessages 查询具体的发送状态。

62a72a20-8a9b-4060-a510-0c30a9340cba
send_timestring

发送时间。

2017-09-01 00:00:00
sign_namestring

签名。

签名
sms_sizestring

短信长度。短信长度不超过 70 个字,按照一条短信计费;超过 70 个字,即为长短信,按照 67 字/条拆分成多条计费。

1
successboolean

是否接收成功。

  • true : 接收成功。
  • false : 接收失败。
true
template_codestring

模板号。

SMS_123456

返回参数

名称类型描述示例值
object

成功获取短信回执。

codeinteger

应答编码。

0
msgstring

描述信息。

接受成功

示例

正常返回示例

JSON格式

{
  "code": 0,
  "msg": "接受成功"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-03-07新增 OpenAPI看变更集

第一次推送失败后,间隔 1 分钟、5 分钟、10 分钟、30 分钟、60 分钟、60 分钟、60 分钟、60 分钟、60 分钟后会进行重推,直至推送成功为止。如果推送 10 次后仍失败,不再重试。

  • 本页导读 (1)
文档反馈