AWS End User Messaging SMS イベントデータの例 - AWS エンドユーザーメッセージング SMS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS End User Messaging SMS イベントデータの例

AWS End User Messaging SMS では、SMS、MMS、および音声メッセージ配信のイベントデータをストリーミングできます。通信事業者が生成したイベントは、受信されるまでに最大 72 時間かかることがあるため、送信メッセージの配信に遅延があるかどうかを判断するのには使用しないでください。72 時間が経過しても、AWS End User Messaging SMS が通信事業者から最終イベントを受信していない場合、そのメッセージに何が起こったのかわからないため、サービスは自動的に UNKNOWNmessageStatus を返します。

SMS サンプルログ

SMS イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。

{ "eventType": "TEXT_SUCCESSFUL", "eventVersion": "1.0", "eventTimestamp": 1686975103470, "isFinal": true, "originationPhoneNumber": "+12065550152", "destinationPhoneNumber": "+14255550156", "isInternationalSend": false, "mcc": "310", "mnc": "800", "messageId": "862a8790-60c0-4430-9b2b-658bdexample", "messageRequestTimestamp": 1686975103170, "messageEncoding": "GSM", "messageType": "PROMOTIONAL", "messageStatus": "SUCCESSFUL", "messageStatusDescription": "Message has been accepted by phone carrier", "context": { "account": "bar" }, "totalMessageParts": 1, "totalMessagePrice": 0.09582, "totalCarrierFee": 0.0 }
属性 説明
eventType

イベントのタイプ。値は「SMS、MMS、音声のイベントタイプ」に記載されています。

eventVersion

イベントの JSON スキーマのバージョン。

eventTimestamp イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。
isFinal これがメッセージの最終ステータスである場合は True となります。中間メッセージステータスがあるため、最終的なメッセージステータスが受信されるまでに最大 72 時間かかる場合があります。
originationPhoneNumber メッセージの送信元の電話番号。
destinationPhoneNumber メッセージを送信しようとした電話番号。
isInternationalSend この電話番号で国際メッセージングが有効になっている場合は True となります。
isoCountryCode 受信者の電話番号に関連付けられている国 (ISO 3166-1 alpha-2 形式で表示)。
mcc モバイル国コードは、電話番号が属する国を識別します。このフィールドはオプションであり、存在しない場合があります。
mnc モバイルネットワークコードは、モバイルネットワークオペレーターを識別します。このフィールドはオプションであり、存在しない場合があります。
messageId メッセージを受け入れるときに AWS End User Messaging SMS が生成する一意の ID。
messageRequestTimestamp SMS メッセージリクエストが送信された時刻で、Unix 時間 (ミリ秒単位) として表示されます。
messageEncoding メッセージのエンコード。指定できる値は GSMUnicode です。メッセージのエンコードの詳細については、「SMS 文字制限」を参照してください。
messageType メッセージのタイプ。指定できる値は、Promotional および Transactionalです。
messageStatus

メッセージのステータス。可能な値は以下のとおりです。

  • SUCCESSFUL – メッセージが電話キャリアによって受け入れられました。

  • DELIVERED – メッセージは受信者のデバイスで受け入れられました。

  • PENDING – メッセージはまだ受信者のデバイスに配信されていません。

  • INVALID – 送信先の電話番号が無効です。

  • UNREACHABLE – 受信者のデバイスが現在到達できないか、利用できません。例えば、デバイスの電源がオフになっているか、ネットワークから切断されている可能性があります。後でメッセージの送信を再試行できます。

  • UNKNOWN – メッセージの配信を妨げるエラーが発生しました。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • BLOCKED – 受信者のデバイスが発信者電話番号からの SMS メッセージをブロックしています。

  • CARRIER_UNREACHABLE – 受信者のモバイルネットワークの問題により、メッセージを配信できませんでした。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • SPAM – 受信者のモバイルキャリアがメッセージのコンテンツをスパムとして識別し、メッセージの配信をブロックしました。

  • INVALID_MESSAGE – SMS メッセージの本文が無効であるため、配信できません。

  • CARRIER_BLOCKED – 受信者のキャリアがこのメッセージの配信をブロックしています。これは、多くの場合、キャリアがメッセージの内容を未承諾または悪意のあるものとして識別した場合に発生します。

  • TTL_EXPIRED – 特定の期間内に SMS メッセージを配信できませんでした。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • ACCEPTED – SMS メッセージが受け入れられました。

  • FAILED – SMS メッセージが受信者のデバイスに配信されませんでした。

  • SENT – メッセージは送信されましたが、受信者のデバイスには配信されていません。

  • UNROUTABLE – アカウント設定が正しくないため、ルーティングできません。

  • QUEUED – メッセージは配信のためにキューに入れられました。

  • PROTECT_BLOCKED – SMS メッセージが SMS 保護ルールによってブロックされました。

messageStatusDescription メッセージステータスの説明。
context カスタム属性を指定でき、メッセージを送信するとログに記録されます。
totalMessageParts

メッセージを送信するために AWS End User Messaging SMS が作成したメッセージパーツの数。

通常、SMS メッセージには GSM-7 文字 160 文字または非 GSM 文字 67 文字のみを含めることができますが、これらの制限は国によって異なる場合があります。これらの制限を超えるメッセージを送信すると、AWS End User Messaging SMS は自動的にメッセージを小さなパーツに分割します。送信したメッセージパートの数に基づいて請求されます。メッセージパーツの詳細については、「メッセージパーツ/秒 (MPS) の制限とは」を参照してください。

totalMessagePrice メッセージの送信に課金された金額。この価格は、米ドルセントの 1000 分の 1 で示されます。例えば、この属性の値が 645 の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = $0.00645)。
totalCarrierFee メッセージに対する通信事業者料金の総額。

SMS Protect のサンプルログ

SMS Protect を使用した場合の SMS イベントの JSON オブジェクトには、以下の例に示されているデータが含まれています。

{ "eventType": "TEXT_PROTECT_BLOCKED", "eventVersion": "1.0", "eventTimestamp": 1686975103470, "isFinal": true, "originationPhoneNumber": "+12065550152", "destinationPhoneNumber": "+14255550156", "isoCountryCode": "US", "mcc": "310", "mnc": "800", "messageId": "862a8790-60c0-4430-9b2b-658bdexample", "messageRequestTimestamp": 1686975103170, "messageEncoding": "GSM", "messageType": "PROMOTIONAL", "messageStatus": "PROTECT_BLOCKED", "messageStatusDescription": "Message blocked by protect configuration", "context": { "account": "bar" }, "totalMessageParts": 1, "totalMessagePrice": 0, "totalCarrierFee": 0, "protectConfiguration": { "protectConfigurationId": "protect-d777777777777771bbd5d59f4d903479", "protectStatus": "FILTER" }, "protectConfigurationAssessment": { "protectRecommendation": "BLOCK" "protectInsights": { "blockReason": "AIT_SUSPECTED" } } }
属性 説明
eventType

イベントのタイプ。値は「SMS、MMS、音声のイベントタイプ」に記載されています。

eventVersion

イベントの JSON スキーマのバージョン。

eventTimestamp イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。
isFinal これがメッセージの最終ステータスである場合は True となります。中間メッセージステータスがあるため、最終的なメッセージステータスが受信されるまでに最大 72 時間かかる場合があります。
originationPhoneNumber メッセージの送信元の電話番号。
destinationPhoneNumber メッセージを送信しようとした電話番号。
isoCountryCode 受信者の電話番号に関連付けられている国 (ISO 3166-1 alpha-2 形式で表示)。
mcc モバイル国コードは、電話番号が属する国を識別します。このフィールドはオプションであり、存在しない場合があります。
mnc モバイルネットワークコードは、モバイルネットワークオペレーターを識別します。このフィールドはオプションであり、存在しない場合があります。
messageId メッセージを受け入れるときに AWS End User Messaging SMS が生成する一意の ID。
messageRequestTimestamp SMS メッセージリクエストが送信された時刻で、Unix 時間 (ミリ秒単位) として表示されます。
messageEncoding メッセージのエンコード。指定できる値は GSMUnicode です。メッセージのエンコードの詳細については、「SMS 文字制限」を参照してください。
messageType メッセージのタイプ。指定できる値は、Promotional および Transactionalです。
messageStatus

メッセージのステータス。可能な値は以下のとおりです。

  • SUCCESSFUL – メッセージが電話キャリアによって受け入れられました。

  • DELIVERED – メッセージは受信者のデバイスで受け入れられました。

  • PENDING – メッセージはまだ受信者のデバイスに配信されていません。

  • INVALID – 送信先の電話番号が無効です。

  • UNREACHABLE – 受信者のデバイスが現在到達できないか、利用できません。例えば、デバイスの電源がオフになっているか、ネットワークから切断されている可能性があります。後でメッセージの送信を再試行できます。

  • UNKNOWN – メッセージの配信を妨げるエラーが発生しました。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • BLOCKED – 受信者のデバイスが発信者電話番号からの SMS メッセージをブロックしています。

  • CARRIER_UNREACHABLE – 受信者のモバイルネットワークの問題により、メッセージを配信できませんでした。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • SPAM – 受信者のモバイルキャリアがメッセージのコンテンツをスパムとして識別し、メッセージの配信をブロックしました。

  • INVALID_MESSAGE – SMS メッセージの本文が無効であるため、配信できません。

  • CARRIER_BLOCKED – 受信者のキャリアがこのメッセージの配信をブロックしています。これは、多くの場合、キャリアがメッセージの内容を未承諾または悪意のあるものとして識別した場合に発生します。

  • TTL_EXPIRED – 特定の期間内に SMS メッセージを配信できませんでした。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • ACCEPTED – SMS メッセージが受け入れられました。

  • FAILED – SMS メッセージが受信者のデバイスに配信されませんでした。

  • SENT – メッセージは送信されましたが、受信者のデバイスには配信されていません。

  • UNROUTABLE – アカウント設定が正しくないため、ルーティングできません。

  • QUEUED – メッセージは配信のためにキューに入れられました。

  • PROTECT_BLOCKED – SMS メッセージが SMS 保護ルールによってブロックされました。

messageStatusDescription メッセージステータスの説明。
context カスタム属性を指定でき、メッセージを送信するとログに記録されます。
totalMessageParts

メッセージを送信するために AWS End User Messaging SMS が作成したメッセージパーツの数。

通常、SMS メッセージには GSM-7 文字 160 文字または非 GSM 文字 67 文字のみを含めることができますが、これらの制限は国によって異なる場合があります。これらの制限を超えるメッセージを送信すると、AWS End User Messaging SMS は自動的にメッセージを小さなパーツに分割します。送信したメッセージパートの数に基づいて請求されます。メッセージパーツの詳細については、「メッセージパーツ/秒 (MPS) の制限とは」を参照してください。

totalMessagePrice メッセージの送信に課金された金額。この価格は、米ドルセントの 1000 分の 1 で示されます。例えば、この属性の値が 645 の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = $0.00645)。
totalCarrierFee メッセージに対する通信事業者料金の総額。
protectConfiguration メッセージの送信時に使用された保護設定の ID と、その時点での送信先の国のステータス。SMS Protect の詳細については、「SMS Protect」を参照してください。
protectConfigurationAssessment SMS Protect がメッセージの送信を許可またはブロックすべきと判断するかどうかの評価と、可能な場合はブロックの理由。

音声イベントログの例

音声イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。

{ "eventType": "VOICE_COMPLETED", "eventVersion": "1.0", "eventTimestamp": 1697835373500, "isFinal": true, "originationPhoneNumber": "+12065550153", "destinationPhoneNumber": "+14255550159", "isoCountryCode": "US", "messageId": "567f6c11-6e8b-4352-9749-a42a0example", "messageRequestTimestamp": 1697835372720, "messageStatus": "COMPLETED", "callDurationInSeconds": 60, "totalDurationInMinutes": 1, "totalMessagePrice": 0.013, "context": { "account": "bar" } }
属性 説明
eventType

イベントのタイプ。値は「SMS、MMS、音声のイベントタイプ」に記載されています。

eventVersion

イベントの JSON スキーマのバージョン。

eventTimestamp イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。
isFinal これがメッセージの最終ステータスである場合は True となります。中間メッセージのステータスがあります。
originationPhoneNumber メッセージの送信元の電話番号。
destinationPhoneNumber メッセージを送信しようとした電話番号。
isoCountryCode 受信者の電話番号に関連付けられている国 (ISO 3166-1 alpha-2 形式で表示)。
messageId メッセージを受け入れるときに AWS End User Messaging SMS が生成する一意の ID。
messageRequestTimestamp SMS メッセージリクエストが送信された時刻で、Unix 時間 (ミリ秒単位) として表示されます。
messageStatus

メッセージのステータス。可能な値は以下のとおりです。

  • INITIATED – 音声メッセージのダイヤルを開始する準備ができています。

  • RINGING - 呼び出しイベントは、電話をかけた後、受信者が応答する前に発生します。

  • COMPLETED – 音声メッセージの完了イベントをすべて、指定された宛先に送信します。完了イベントは、音声メッセージが受信者に対して再生されたときに発生します。この状態は、メッセージが必ずしも受信者に配信されたことを意味するわけではありません。例えば、メッセージがボイスメールシステムに配信されたことを示す場合があります。

  • ANSWERED – 応答イベントは、受信者が電話に応答したときに発生します。

  • COMPLETED – 通話に応答し、終了しました。

  • BUSY – ビジーイベントは、受信者の電話回線がビジー状態のときに発生します。

  • NO_ANSWER – 応答なしイベントは、電話をかけたが受信者 (またはボイスメールシステム) が応答しなかったときに発生します。

  • FAILED – 失敗イベントは、メッセージが配信されなかったときに発生します。

  • TTL_EXPIRED – TTL 伝送期限切れイベントは、メッセージの配信に必要な時間が、メッセージ送信時に指定した TTL 値を超えたときに発生します。

  • SPAM – 通話はスパムとしてマークされ、ブロックされました。

  • PROTECT_BLOCKED – SMS メッセージが SMS 保護ルールによってブロックされました。

callDurationInSeconds 通話の長さ (秒単位)。
totalDurationInMinutes 通話時間 (分単位)。
totalMessagePrice 音声メッセージの送信に課金された金額。この価格は、米ドルセントの 1000 分の 1 で示されます。
context カスタム属性を指定でき、メッセージを送信するとログに記録されます。

MMS サンプルログ

MMS イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。

{ "contentType":"MMS", "eventType": "MEDIA_DELIVERED", "eventVersion": "1.0", "eventTimestamp": 1635197695208, "isFinal": true, "originationPhoneNumber": "+12065550153", "destinationPhoneNumber": "+14255550159", "isoCountryCode": "US", "messageId": "b4a3196d-5b61-4884-a0d9-745acf1f6235example", "messageRequestTimestamp": 1635197693241, "messageType": "TRANSACTIONAL", "messageStatus": "DELIVERED", "messageStatusDescription": "Message has been accepted by phone", "context": {"foo":"bar"}, "totalMessageParts": 1, "totalMessagePrice": 0.0195, "totalCarrierFee": 0.00266 }
属性 説明
eventType

イベントのタイプ。値は「SMS、MMS、音声のイベントタイプ」に記載されています。

eventVersion

イベントの JSON スキーマのバージョン。

eventTimestamp イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。
isFinal これがメッセージの最終ステータスである場合は True となります。中間メッセージステータスがあるため、最終的なメッセージステータスが受信されるまでに最大 72 時間かかる場合があります。
originationPhoneNumber メッセージの送信元の電話番号。
destinationPhoneNumber メッセージを送信しようとした電話番号。
isoCountryCode 受信者の電話番号に関連付けられている国 (ISO 3166-1 alpha-2 形式で表示)。
messageId メッセージを受け入れるときに AWS End User Messaging SMS が生成する一意の ID。
messageRequestTimestamp SMS メッセージリクエストが送信された時刻で、Unix 時間 (ミリ秒単位) として表示されます。
messageType メッセージのタイプ。指定できる値は、Promotional および Transactionalです。
messageStatus

メッセージのステータス。可能な値は以下のとおりです。

  • SUCCESSFUL – メッセージが電話キャリアによって受け入れられました。

  • DELIVERED – メッセージは受信者のデバイスで受け入れられました。

  • PENDING – メッセージはまだ受信者のデバイスに配信されていません。

  • INVALID – 送信先の電話番号が無効です。

  • UNREACHABLE – 受信者のデバイスが現在到達できないか、利用できません。例えば、デバイスの電源がオフになっているか、ネットワークから切断されている可能性があります。後でメッセージの送信を再試行できます。

  • UNKNOWN – メッセージの配信を妨げるエラーが発生しました。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • BLOCKED – 受信者のデバイスが発信者電話番号からの SMS/MMS メッセージをブロックしています。

  • CARRIER_UNREACHABLE – 受信者のモバイルネットワークの問題により、メッセージを配信できませんでした。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • SPAM – 受信者のモバイルキャリアがメッセージのコンテンツをスパムとして識別し、メッセージの配信をブロックしました。

  • INVALID_MESSAGE – SMS/MMS メッセージの本文が無効であるため、配信できません。

  • CARRIER_BLOCKED – 受信者のキャリアがこのメッセージの配信をブロックしています。これは、多くの場合、キャリアがメッセージの内容を未承諾または悪意のあるものとして識別した場合に発生します。

  • TTL_EXPIRED – 特定の期間内に SMS メッセージを配信できませんでした。このエラーは通常一時的なものであるため、後でもう一度メッセージを送信できます。

  • ACCEPTED – SMS メッセージが受け入れられました。

  • FAILED – SMS メッセージが受信者のデバイスに配信されませんでした。

  • SENT – メッセージは送信されましたが、受信者のデバイスには配信されていません。

  • UNROUTABLE – アカウント設定が正しくないため、ルーティングできません。

  • QUEUED – メッセージは配信のためにキューに入れられました

messageStatusDescription メッセージステータスの説明。
context カスタム属性を指定でき、メッセージを送信するとログに記録されます。
totalMessageParts

メッセージを送信するために AWS End User Messaging SMS が作成したメッセージパーツの数。メッセージパーツの詳細については、「メッセージパーツ/秒 (MPS) の制限とは」を参照してください。

totalMessagePrice メッセージの送信に課金された金額。この価格は、米ドルセントの 1000 分の 1 で示されます。例えば、この属性の値が 645 の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = $0.00645)。
totalCarrierFee メッセージに対する通信事業者料金の総額。