メインコンテンツまでスキップ

Webhooks -- 配信レシート

配信レシート​

SMSの配信に成功、またはSMSを配信できない場合は、配信レシートがWebhookアドレスに送信されます。 このWebhookアドレスは、APIにアクセスするために設定したAPIキーの構成の一部としてダッシュボードで設定できます。 または、SMS送信リクエストの"delivery_receipts"要素の"custom_callback_url"フィールドにデータを入力することで、このWebhookアドレスをメッセージごとに上書きできます。

配信レシートは、メッセージの送信後、最大24時間以内に届きます。 配信レシートのWebhookは、"HTTP 200 OK"レスポンスで取得されます。 配信レシートがWebhookアドレスに接続できない場合、または"HTTP 200 OK"以外のレスポンスを受信した場合は、キューに入れられ、最大24時間まで再試行されてから、破棄されます。

Webhook呼び出しは、リクエスト本文にJSON形式を含むPOSTとして送信されます。 次の形式になります。

{
  "message_id": "...the message id returned in the Submit SMS API request...",
  "sender_address": "...sender address...",
  "destination_address": "...destination phone number...",
  "status": "DELIVRD",
  "error_code": 0,
  "smsc_timestamp": "yyyy/mm/dd hh:mm:ss"
  "client_reference": "...if provided during original request..."
}

ステータス値リスト​

ステータス（英版）ステータス（日本語版）最終結果詳細
DELIVRD送信成功YesSMSの配信に成功しました。
EXPIRED期限切れYes配信に失敗し、ネットワークは再試行しなくなります。
DELETED削除YesこのSMSの配信は、ネットワークのある時点で中止されました。
UNDELIV未達Yes何らかの理由でSMS配信ができなかったため、ネットワーク内で中止されました。
REJECTDリジェクトYesメッセージは、配信の適切な基準を満たしていなかったため、ネットワークに送信する前に拒否されました。
ENROUTE送信中Noメッセージはネットワークのネクストホップによって受け入れられましたが、まだハンドセットに配信されていません。
UNKNOWN不明Yesメッセージの配信結果は不明です。サポートされていないイベントがネットワークから受信されました。
SUBMITTED送信中Noメッセージはネットワークのネクストホップによって受け入れられましたが、まだステータス値を受け取っていません。
ACCEPTD送信中Noメッセージはネットワークのネクストホップによって受け入れられましたが、まだハンドセットに配信されていません。