メッセージング・オプトアウト・ナンバーズ

メッセージを送信しようとした場合への送信する番号からのメッセージ受信を拒否している番号よりその場合、メッセージの送信はブロックされ、Delivery Receipt (SMS API) または Status Webhook (Messages API) でエラー・レスポンスを受け取ります。

SMS API

もしあなたが SMS API経由でSMSメッセージを送信する。として設定された Numbers は to として設定した番号からのメッセージの受信を拒否している。 fromというステータスコードでHTTPレスポンスを受け取るはずである。 200そして status フィールドを持つ。 0.これは、メッセージが正常に送信されたことを示します。 提出済み をお受け取りください。ただし、その後 POST を受信するように設定したウェブフック・アドレスにリクエストを送る。領収書.リクエスト本文には status フィールドに failed または rejectedそして err-code フィールドに 9.これはエラーコードは、ユーザーが送信番号からのメッセージを受信しないように要求したことを示す。

納品書本文の例

{
   "msisdn": "447700900000",
   "to": "AcmeInc",
   "network-code": "12345",
   "messageId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "price": "0.00000000",
   "status": "failed",
   "scts": "2001011400",
   "err-code": "9",
   "api-key": "abcd1234",
   "message-timestamp": "2020-01-01 12:00:00"
}

Messages API

もしあなたが Messages API経由でSMSまたはMMSメッセージを送信する。として設定されたNumbersを指す。 to として設定した番号からのメッセージの受信を拒否している。 fromというステータスコードでHTTPレスポンスを受け取るはずである。 202そして message_uuid フィールドに、メッセージの一意 UUID の値を入れる。これは、メッセージが 提出済み をお受け取りください。ただし、その後 POST を受信するように設定したウェブフック・アドレスにリクエストを送る。ステータスウェブフック.リクエスト本文には message_uuid フィールドに、最初のHTTPレスポンスのUUIDと同じ値を入れる。リクエストボディには status フィールドに rejected の詳細を持つオブジェクトを含むエラーフィールド。なぜメッセージは拒否された。この場合、オブジェクトは title フィールドエラーコードの 1240.これは、ユーザーが送信番号からのメッセージを受信しないように要求したことを示す。

メッセージ・ステータス Webhook ボディの例

{
   "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "to": "447700900000",
   "from": "447700900001",
   "timestamp": {},
   "status": "rejected",
   "error": {
      "type": "https://developer.vonage.com/api-errors/messages-olympus#1240",
      "title": 1240,
      "detail": "Illegal Number - You tried to send a message to a blocklisted phone number. That is, the user has already sent a STOP opt-out message and no longer wishes to receive messages from you.",
      "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
   },
   "usage": {
      "currency": "EUR",
      "price": "0.0000"
   },
   "client_ref": "string",
   "channel": "sms",
   "destination": {
      "network_code": "12345"
   },
   "sms": {
      "count_total": "1"
   }
}