全部产品
Search
文档中心

短信服务:SmsReport

更新时间:Jul 01, 2024

您可以指定HTTP URL来接收短信发送状态报告,调用接口发送短信后,SmsReport会调用您提供的HTTP URL传递短信发送情况。

重要

回执消息无法保证幂等性,因此需要您自行处理幂等性的问题。我们建议您在接收到回执消息后,采取适当的措施来确保数据的正确性和一致性。

协议说明

参数

说明

协议

HTTP + JSON

编码

UTF-8

短信回执消息SmsReport消息体格式

POST数据的内容为JSON Array格式,即回执会对结果消息合并,单次推送可能会包含多个状态报告结果。

名称

类型

示例

描述

To

String

8521234****

短信接收号码。

Status

String

1

发送状态。

  • 1:成功

  • 2:失败

  • 6:失效

MessageId

String

123456789****

发送回执ID。

SmsSize

String

1

短信条数。长短信将会被拆分为多条发送。

TaskId

String

123456

批次ID,调用发送接口时传的taskId。

SendDate

String

Thu, 25 Nov 2021 10:27:00 +0800

提交给运营商的时间。

ReceiveDate

String

Thu, 25 Nov 2021 10:27:33 +0800

收到运营商回执的时间。

ErrorCode

String

success

错误码。

ErrorDescription

String

success

错误信息。

示例

[{
    "To" : "8521111****",
    "SendDate" : "Thu, 25 Nov 2021 10:25:00 +0800",
    "ReceiveDate" : "Thu, 25 Nov 2021 10:25:33 +0800",
    "Status" : "1",
    "ErrorCode" : "success",
    "ErrorDescription" : "success",
    "TaskId" : "67890",
    "SmsSize":"2",
    "MessageId" : "123450000****"
  }]

响应说明

接收到回执后,响应的HTTP状态码必须为200,且响应体格式需如下所示,否则会推送失败,触发重新推送。

  • 响应样例

    {
      "code" : 0,
      "msg" : "接收成功"
    }
  • 字段说明

    名称

    类型

    是否必选

    示例值

    描述

    code

    Number

    0

    应答编码。

    msg

    String

    接收成功

    描述信息。

重新推送

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