短信發送狀態報告接口定義。
接口說明
您可以指定 HTTP URL 來接收由短信服務推送的短信發送狀態報告,然后 SmsReport 使用 HTTP 服務接收消息傳遞報告。 您可以使用 UpdateReportUrl 更新您的接收服務 URL。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
POST /api/v2/recall/report
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object [] | 否 | 請求參數的主體信息。 | |
biz_id | string | 否 | 發送回執 ID,即發送流水號。 | 12345 |
err_code | string | 否 | 狀態報告編碼。 | DELIVERED |
err_msg | string | 否 | 狀態報告說明。 | 用戶接收成功 |
message_id | string | 否 | 短信 ID。調用發送接口 SendMessage 發送短信時,返回值中的 ID 字段。可使用短信 ID 在接口 ListMessages 查詢具體的發送狀態。 | 123 |
out_id | string | 否 | 外部拓展字段。 | 123 |
phone_number | string | 否 | 手機號碼。 | 1390000**** |
report_time | string | 否 | 狀態報告時間。 | 2017-09-01 00:00:00 |
request_id | string | 否 | 短信批處理 ID。調用發送接口 SendMessage 發送短信時,返回值中的 RequestId 字段。可使用短信批處理 ID 在接口 ListMessages 查詢具體的發送狀態。 | 62a72a20-8a9b-4060-a510-0c30a9340cba |
send_time | string | 否 | 發送時間。 | 2017-09-01 00:00:00 |
sign_name | string | 否 | 簽名。 | 簽名 |
sms_size | string | 否 | 短信長度。短信長度不超過 70 個字,按照一條短信計費;超過 70 個字,即為長短信,按照 67 字/條拆分成多條計費。 | 1 |
success | boolean | 否 | 是否接收成功。
| true |
template_code | string | 否 | 模板號。 | SMS_123456 |
返回參數
示例
正常返回示例
JSON
格式
{
"code": 0,
"msg": "接受成功"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-03-07 | 新增 OpenAPI | 看變更集 |
第一次推送失敗后,間隔 1 分鐘、5 分鐘、10 分鐘、30 分鐘、60 分鐘、60 分鐘、60 分鐘、60 分鐘、60 分鐘后會進行重推,直至推送成功為止。如果推送 10 次后仍失敗,不再重試。