SmsReport - Short Message Service

您可以指定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次後仍失敗，不再重試。

名稱	類型	是否必選	樣本值	描述
code	Number	是	0	應答編碼。
msg	String	否	接收成功	描述資訊。