SMS イベント

SMS チャンネルがプロジェクトに対して有効になっている場合、Amazon Pinpoint はプロジェクトの SMS メッセージ配信に関するイベントデータをストリーミングできます。通信事業者が生成した SMS イベントは、受信されるまでに最大 72 時間かかることがあるため、送信メッセージの配信に遅延があるかどうかを判断するのには使用しないでください。72 時間が経過しても、Amazon Pinpoint が通信事業者から最終イベントを受信していない場合、そのメッセージに何が起こったのかわからないため、サービスは自動的に UNKNOWN のrecord_status を返します。

例

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 API を直接呼び出すか、Amazon Pinpoint コンソールを使用してトランザクション SMS メッセージを送信する場合、このオブジェクトは空です。

属性

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

属性	説明
`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_QUOTA_LEFT_ON_ACCOUNT – メッセージを送信するのに十分な使用クォータがアカウントに残っていません。Amazon Pinpoint ユーザーガイドの毎月の SMS クォータの増額を申請するの手続きを行うことで、この枠の増額を申請することができます。 NO_ORIGINATION_IDENTITY_AVAILABLE_TO_SEND – アカウントには、宛先へのメッセージの送信に使用できる電話番号が含まれていません。 DESTINATION_COUNTRY_NOT_SUPPORTED – 送信先の国がブロックされています。サポートされている国については、「Supported countries and regions (SMS channel)」を参照してください。 ACCOUNT_IN_SANDBOX – アカウントはサンドボックス内にあり、検証済みの宛先番号にのみ送信できます。Amazon Pinpoint コンソールで宛先番号を検証するか、アカウントをサンドボックス外に移動するプロセスを開始できます。「Moving from the Amazon Pinpoint SMS sandbox to production」を参照してください。 RATE_EXCEEDED – メッセージの送信が速すぎたため、スロットリングされました。コールレートを下げる必要があります。制限の詳細については、「Message Parts per Second (MPS) limits」を参照してください。 INVALID_ORIGINATION_IDENTITY – 指定された送信元 ID は無効です。 ORIGINATION_IDENTITY_DOES_NOT_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_SUPPORTED_FOR_DESTINATION – 送信先の国は送信者 ID をサポートしていません。送信には、電話番号または別の送信元 ID を使用する必要があります。 INVALID_PHONE_NUMBER – 指定された発信元の電話番号は無効です。電話番号の形式または長さが正しくない可能性があります。
`iso_country_code`	受信者の電話番号に関連付けられている国 (ISO 3166-1 alpha-2 形式で表示)。
`treatment_id`	メッセージが A/B キャンペーンで送信された場合のメッセージ処理の ID。
`treatment_id`	メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。トランザクション SMS メッセージの場合、この値は 0 です。
`number_of_message_parts`	メッセージを送信するために Amazon Pinpoint が作成したメッセージパートの数。通常、SMS メッセージには GSM-7 文字 160 文字または非 GSM 文字 67 文字のみを含めることができますが、これらの制限は国によって異なる場合があります。これらの制限を超えるメッセージを送信すると、Amazon Pinpoint は自動的にメッセージを小さなパートに分割します。送信したメッセージパートの数に基づいて請求されます。
`message_id`	メッセージを受け入れるときに Amazon Pinpoint が生成する一意の ID。
`message_type`	メッセージのタイプ。指定できる値は、Promotional および Transactionalです。この値は、キャンペーンの作成時、または Amazon Pinpoint API の SendMessages オペレーションを使用してトランザクションメッセージを送信する際に指定します。
`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。

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` が _SMS.BUFFERED のメッセージには表示されません。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

E メールイベント

分析データのクエリを実行する