SMS Amazon Pinpoint からのイベントデータストリーム - Amazon Pinpoint
SMS イベントの例SMS イベント属性

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

SMS Amazon Pinpoint からのイベントデータストリーム

プロジェクトでSMSチャネルが有効になっている場合、Amazon Pinpoint はプロジェクトのSMSメッセージ配信に関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からイベントデータを取得して表示します。イベントストリーミングの設定方法については、「」を参照してください Amazon Kinesis または Amazon Data Firehose を介してアプリケーションイベントデータをストリーミングするように Amazon Pinpoint を設定する 。

注記

SMS 通信事業者によって生成されるイベントは、受信までに最大 72 時間かかる場合があり、アウトバウンドメッセージ配信に遅延があるかどうかを判断するために使用しないでください。72 時間後、Amazon Pinpoint がキャリアから最終イベントを受信していない場合、Amazon Pinpoint はメッセージに何が起こったかわからないため、サービスは自動的に UNKNOWN record_status を返します。

SMS イベントの例

SMS イベントのJSONオブジェクトには、次の例に示すデータが含まれます。

{
  "event_type": "_SMS.SUCCESS",
  "event_timestamp": 1553104954322,
  "arrival_timestamp": 1553104954064,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "123456789012"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "sender_request_id": "565d4425-4b3a-11e9-b0a5-example",
    "campaign_activity_id": "cbcfc3c5e3bd48a8ae2b9cb41example",
    "origination_phone_number": "+12065550142",
    "destination_phone_number": "+14255550199",
    "record_status": "DELIVERED",
    "iso_country_code": "US",
    "treatment_id": "0",
    "number_of_message_parts": "1",
    "message_id": "1111-2222-3333",
    "message_type": "Transactional",
    "campaign_id": "52dc44b35c4742c98c5935269example"
  },
  "metrics": {
    "price_in_millicents_usd": 645.0
  },
  "awsAccountId": "123456789012"
}

SMS イベント属性

このセクションでは、SMSメッセージを送信するときに Amazon Pinpoint が生成するイベントストリームデータの前の例に含まれる属性を定義します。

イベント
属性 説明
event_type

イベントのタイプ。可能な値は以下のとおりです。

  • _SMS.BUFFERED – メッセージはまだ受信者に配信中です。

  • _SMS.SUCCESS – メッセージは通信事業者によって正常に受け入れられ、受信者に配信されました。

  • _SMS.FAILURE – Amazon Pinpoint は受信者にメッセージを配信できませんでした。メッセージを配信できない原因となったエラーの詳細については、「attributes.record_status」を参照してください。

  • _SMS.OPTOUT – 顧客はメッセージを受け取り、オプトアウトキーワード (通常はSTOP「」) を送信して返信しました。
event_timestamp

イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。
arrival_timestamp

イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。
event_version

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

ヒント

イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。
application

イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「アプリケーション」を参照してください。
client

イベントをレポートしたデバイスにインストールされているアプリクライアントに関する情報。詳細については、表「クライアント」を参照してください。
device

イベントを報告したデバイスに関する情報。詳細については、表「デバイス」を参照してください。

SMS イベントの場合、このオブジェクトは空です。
session SMS イベントの場合、このオブジェクトは空です。
attributes

イベントに関連付けられている属性。アプリケーションの 1 つによって報告されるイベントの場合、このオブジェクトにはアプリケーションによって定義されたカスタム属性を含めることができます。キャンペーンを送信したときに作成されたイベントの場合、このオブジェクトにはキャンペーンに関連付けられた属性が含まれています。トランザクションメッセージを送信するときに生成されるイベントの場合、このオブジェクトにはメッセージ自体に関連する情報が含まれます。

詳細については、表「属性」を参照してください。
metrics

イベントに関連付けられている追加のメトリクス。詳細については、表「メトリクス」を参照してください。
awsAccountId

メッセージの送信に使用された AWS アカウントの ID。

アプリケーション

イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報と、該当する場合は、イベントのレポートにSDK使用された に関する情報が含まれます。

属性 説明
app_id

イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。
sdk

イベントの報告にSDK使用された 。Amazon Pinpoint を直接呼び出すか、Amazon Amazon Pinpoint コンソールを使用してトランザクションSMSメッセージを送信すると、このオブジェクトは空になります。 API

属性

イベントに関連付けられている属性に関する情報が含まれています。

属性 説明
sender_request_id

SMS メッセージの送信リクエストに関連付けられている一意の ID。
campaign_activity_id キャンペーン内のアクティビティの一意の ID。
origination_phone_number

メッセージの送信元の電話番号。
destination_phone_number

メッセージを送信しようとした電話番号。
record_status

メッセージのステータスに関する追加情報。可能な値は以下のとおりです:

  • SUCCESSFUL/DELIVERED – メッセージは正常に配信されました。

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

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

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

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

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

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

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

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

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

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

  • MAX_PRICE_EXCEEDED – メッセージを送信すると、アカウントの月間SMS支出クォータを超えた料金が発生します。このクォータの引き上げをリクエストするには、Amazon Pinpoint ユーザーガイド」の「毎月のSMS支出クォータの引き上げをリクエストする」の手順を完了します。

  • OPTED_OUT – 受信者がユーザーからのSMSメッセージの受信をオプトアウトしたため、メッセージは送信されませんでした。

  • NO_QUOTALEFT_ON_ACCOUNT – メッセージを送信するのに十分な支出クォータがアカウントに残っていません。このクォータの引き上げをリクエストするには、AWS 「エンドユーザーメッセージングSMSユーザーガイド」の「毎月のSMS支出クォータの引き上げをリクエストする」の手順を完了します。

  • NO_ORIGINATION_IDENTITYAVAILABLE_TO_SEND – アカウントには、送信先にメッセージを送信するために使用できる電話番号が含まれていません。

  • DESTINATION_COUNTRY_NOT_SUPPORTED – 送信先の国はブロックされています。サポートされているすべての国については、AWS 「エンドユーザーメッセージングSMSユーザーガイド」の「サポートされている国とリージョン (SMSチャンネル）」を参照してください。

  • ACCOUNT_IN_SANDBOX – アカウントはサンドボックスにあり、検証済みの送信先番号にのみ送信できます。Amazon Pinpoint コンソールで送信先番号を確認するか、サンドボックスからアカウントを移動するプロセスを開始できます。AWS 「エンドユーザーメッセージングSMSユーザーガイド」のSMS「/MMS および音声サンドボックスについて」を参照してください。

  • RATE_EXCEEDED – メッセージを送信しようとしすぎてスロットリングされました。コールレートを下げる必要があります。制限の詳細については、「エンドユーザーメッセージングユーザーガイド」の「メッセージパーツ/秒 (MPS) の制限」を参照してください。 AWS SMS

  • INVALID_ORIGINATION_IDENTITY – 指定された送信元 ID が無効です。

  • ORIGINATION_IDENTITY_DOESNOT_ EXIST- 指定された送信元 ID は存在しません。

  • INVALID_DLT_PARAMETERS – 無効なDLTパラメータ (インドの宛先に必須) が指定されました。

  • INVALID_PARAMETERS – 無効なパラメータが指定されました。

  • ACCESS_DENIED – アカウントはメッセージの送信をブロックされています。カスタマーサポートに連絡して原因を突き止め、問題を解決してください。

  • INVALID_KEYWORD – 指定されたキーワードが無効です。キーワードの形式が間違っているか、キーワードがアカウントで設定されていない可能性があります。

  • INVALID_SENDER_ID – 指定された送信者 ID が無効です。送信者 ID の形式または長さが正しくない可能性があります。

  • INVALID_POOL_ID – 指定されたプール ID が無効です。プール ID の形式が間違っているか、プール ID がアカウントに属していない可能性があります。

  • SENDER_ID_NOT_SUPPORTEDFOR_DESTINATION – 送信先の国は送信者 ID をサポートしていません。送信には、電話番号または別の送信元 ID を使用する必要があります。

  • INVALID_PHONE_NUMBER – 指定された発信元の電話番号が無効です。電話番号の形式または長さが正しくない可能性があります。
iso_country_code

3166-1 alpha-2 ISO 形式で表示される、受信者の電話番号に関連付けられている国。
treatment_id

メッセージが A/B キャンペーンで送信された場合のメッセージ処理の ID。
treatment_id

メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。トランザクションSMSメッセージの場合、この値は 0 です。
number_of_message_parts

メッセージを送信するために Amazon Pinpoint が作成したメッセージパートの数。

通常、SMSメッセージには 160GSM～7 文字または 67 文字以外のGSM文字のみを含めることができますが、これらの制限は国 によって異なる場合があります。これらの制限を超えるメッセージを送信すると、Amazon Pinpoint は自動的にメッセージを小さなパートに分割します。送信したメッセージパートの数に基づいて請求されます。
message_id

メッセージを受け入れるときに Amazon Pinpoint が生成する一意の ID。
message_type

メッセージのタイプ。指定できる値は、Promotional および Transactionalです。この値は、キャンペーンを作成するとき、または Amazon Pinpoint の SendMessagesオペレーションを使用してトランザクションメッセージを送信するときに指定しますAPI。
campaign_id

メッセージを送信した Amazon Pinpoint キャンペーンの一意の ID。

クライアント

イベントをレポートしたデバイスにインストールされているアプリクライアントに関する情報が含まれています。

属性 説明
client_id

アプリによって生成されたイベントの場合、この値はデバイスにインストールされたアプリクライアントの一意の ID です。この ID は、 AWS Mobile SDK for iOS と によって自動的に生成されます AWS Mobile SDK for Android。

キャンペーンやトランザクションメッセージの送信時に生成されるイベントの場合、この値はメッセージの送信先のエンドポイントの ID と同じです。
cognito_id アプリケーションが使用する Amazon Cognito ID プールのアプリクライアントに割り当てられた一意の ID。

デバイス

イベントを報告したデバイスに関する情報が含まれています。

属性 説明
locale デバイスロケール。
make デバイスのメーカー (Apple、Samsung など)。
model デバイスモデル (iPhone など)。
platform デバイスのプラットフォーム (ios、android など)。

メトリクス

イベントに関連付けられているメトリクスに関する情報が含まれています。

属性 説明
price_in_millicents_usd

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

注記

このプロパティは、 が _ event_typeのメッセージには表示されません。 SMSBUFFERED