すべてのプロダクト
Search
ドキュメントセンター

Short Message Service:SMS webhook

最終更新日:Aug 05, 2024

コールバックURLを指定して、HTTPサーバーから配信レシートを取得できます。 コールバックURLを設定することで、SMSメッセージのステータスに関するタイムリーで正確な情報を確実に受け取ることができます。

重要

配達領収書のべき等性は保証できません。 配送領収書を受け取った後、データの正確性と一貫性を確保するために適切な対策を講じることを推奨します。

プロトコル

パラメーター

説明

プロトコル

HTTP + JSON

Encoding

UTF-8

リクエストパラメーター

POSTリクエストのデータはJSON配列形式です。 一度に複数の配信レシートをHTTPサーバにプッシュすることができる。

パラメーター

データ型

説明

To

String

8521234 ****

配達領収書を受け取る携帯電話番号。

Status

String

1

メッセージのステータス。

  • 1: メッセージが送信されました。

  • 2: メッセージの送信に失敗しました。

  • 6: メッセージの有効期限が切れました。

MessageId

String

123456789****

配送レシートのID。

SmsSize

String

1

メッセージの数。 長いメッセージは複数のメッセージに分割される。

TaskId

String

123456

タスクのID。

SendDate

String

11月25日木曜日2021 10:27:00 + 0800

メッセージがキャリアに送信された時刻。

ReceiveDate

String

11月25日木曜日10:2021 33 0800

運送業者から配達領収書を受け取った時刻。

ErrorCode

String

success

エラーコードを示します。

エラーの説明

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" : "The message is received."
    }
  • レスポンスパラメーター

    パラメーター

    データ型

    必須

    説明

    code

    必須

    0

    レスポンスのコード。

    msg

    String

    任意

    受信済み

    エラーメッセージを示します。

リトライ

システムは、配送レシートのプッシュに失敗した後、配送レシートがプッシュされるまで、1分または5分後に配送レシートを再度プッシュしようとします。 3回連続して配送レシートのプッシュに失敗すると、配送レシートのプッシュを停止します。