イベント形式の割り当て

イベント形式の割り当ては、受信メッセージがどのように構造化され、Webhook に配信されるかを定義します。

各サブスクリプションは、処理の一貫性を確保するためにチャネル固有のデフォルト形式を自動的に受け取ります。デフォルトの形式が要件を満たさない場合は、使用可能なチャネルでサポートされている別の形式を選択できます。これにより、Webhook に送信されるペイロード構造を制御できます。

チャネルごとの既定の形式

各サブスクリプションでは、受信メッセージを処理するための既定の形式が自動的に割り当てられます。これらの形式は、受信メッセージの一貫した処理を保証するためにチャネル固有です。

サポートされているチャネルでは、次の定義済みの JSON ベースの形式を使用して、受信メッセージを構造化および処理します。

選択可能なイベント形式

イベント形式を使用して、Webhook にイベントを受信するペイロードを選択します。

イベント形式は現在、Apple Messages for Business、Facebook Messenger、MMS、SMS、オープンチャネル、ブロックリスト、モバイルIDイベントで選択できます。他のチャンネルやイベントの形式を変更する必要がある場合は、 サポート (opens in a new tab)にお問い合わせください。

次の 2 つのオプションから選択できます。

• 静的形式: 特定の API バージョン (SMS API v3 や MMS API v1 など) に対応するペイロード スキーマを修正しました。その種類のすべてのイベントは、元のメッセージの送信方法に関係なく、選択したスキーマで配信されます。
• アダプティブ サブスクリプション形式: 元のメッセージの送信に使用した API と一致するペイロードをシステムが配信する動的スキーマ。

以下のカテゴリを選択して、選択可能な形式を確認してください。

ChannelsNumbers and sendersTools

Apple Messages for Business

出来事	形式名	ペイロードのフォーマット
配達	adaptive.subscription.format (アダプティブ サブスクリプション フォーマット)	ペイロードは、申請で使用される API に基づいて選択されます
	delivery.apple-messages-for-business.v3.json	例: AMB 配信レポートの受信 (opens in a new tab)
	delivery.apple-messages-for-business.v4.json	例: 配信レポートの受信 (opens in a new tab)
受信メッセージ	inbound-message.apple-messages-for-business.v1.json	例: 受信メッセージの受信 (opens in a new tab)
	inbound-message.apple-messages-for-business.v2.json	例: 受信メッセージの受信 (opens in a new tab)

Facebook Messenger

出来事	形式名	ペイロードのフォーマット
配達	adaptive.subscription.format (アダプティブ サブスクリプション フォーマット)	ペイロードは、申請で使用される API に基づいて選択されます
	delivery.facebook.v5.json	例: 配信レポートの受信 (opens in a new tab)
	delivery.facebook.v4.json	例: Messenger配信レポートの受信 (opens in a new tab)
受信メッセージ	inbound-message.facebook.v1.json	例: 受信メッセージの受信 (opens in a new tab)
	inbound-message.facebook.v2.json	例: 受信メッセージの受信 (opens in a new tab)
マーケティングオプトイン	marketing.facebook.v1.json	例: Messenger オプトインマーケティングイベントの受信 (opens in a new tab)
マーケティングのオプトアウト	marketing.facebook.v1.json	例:Messengerの オプトアウトマーケティングイベントの受信 (opens in a new tab)

SMS

出来事	形式名	ペイロードのフォーマット
クリック	tracking.sms.v1.json	例: SMS トラッキング通知の受信 (opens in a new tab)
配達	adaptive.subscription.format (アダプティブ サブスクリプション フォーマット)	ペイロードは、申請で使用される API に基づいて選択されます
	delivery.sms.v2.json	例: 配信ステータスレポートの受信 (opens in a new tab)
	delivery.sms.v3.json	例: 送信 SMS メッセージ レポートの受信 (opens in a new tab)
	delivery.sms.v4.json	例: アウトバウンド SMS メッセージ レポートの受信 (opens in a new tab)
	delivery.sms.v5.json	例: 配信レポートの受信 (opens in a new tab)
受信メッセージ	inbound-message.sms.v1.json	例: インバウンド SMS メッセージを受信する (opens in a new tab)
	inbound-message.sms.v2.json	例: 受信メッセージの受信 (opens in a new tab)

MMS

出来事	形式名	ペイロードのフォーマット
クリック	tracking.mms.v1.json	例: MMS トラッキング通知の受信 (opens in a new tab)
配達	adaptive.subscription.format (アダプティブ サブスクリプション フォーマット)	ペイロードは、申請で使用される API に基づいて選択されます
	delivery.mms.v1.json	例: 送信 MMS メッセージ レポートの受信 (opens in a new tab)
	delivery.mms.v3.json	例: 配信レポートの受信 (opens in a new tab)
	delivery.mms.v4.json	例: MMS 配信レポートの受信 (opens in a new tab)
受信メッセージ	inbound-message.mms.v1.json	例: 受信 MMS メッセージの受信 (opens in a new tab)
	inbound-message.mms.v2.json	例: 受信メッセージの受信 (opens in a new tab)

Open Channel

出来事	形式名	ペイロードのフォーマット
配達	'イベント.open-channel.v1.json'	例: オープン チャネル送信メッセージの受信 (opens in a new tab)

別の形式を選択する方法

サブスクリプションの作成または編集では、別の形式を選択できます。

Webインターフェイス

1. ログイン (opens in a new tab) して、[開発者ツール] > [サブスクリプション管理]** に移動します。
2. 一覧から SMS または MMS サブスクリプションを見つけます。
3. サブスクリプション名の横にある 3 ドット メニュー を開き、[編集] を選択します。
4. イベントの選択 画面で、ドロップダウンから希望するイベント形式を選択します。
5. サブスクリプションを保存して、新しい設定を適用します。

API

サブスクリプション を作成 (opens in a new tab) または 更新 (opens in a new tab) するときにイベント形式を設定するには、「イベント」オブジェクトにformatフィールドを含めます。

フォーマットなしの例(デフォルトが適用されます):

"events": [
  "DELIVERY"
]

選択した形式の例:

"events": [
  {
    "event": "DELIVERY",
    "format": "delivery.sms.v3.json"
  }
]