イベント形式の割り当て

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

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

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

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

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

選択可能なイベント形式

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

現在、SMS および MMS チャネル イベントでイベント形式を選択できます。他のチャンネルやイベントの形式を変更する必要がある場合は、 サポート (opens in a new tab)にお問い合わせください。

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

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

別の形式を選択する方法

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

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"
  }
]