Webhook の作成 webhook

recommendation-more-help

Journey Optimizerで新しい API 資格情報が作成された場合、SMS Webhook で受信キーワードと、配信やエラーなどのフィードバックイベントの両方を取り込めるようになりました。 プロバイダーごとに機能が異なるので、Webhook を有効にする手順は別個にあります。
Webhook でカスタムプロバイダーがサポートされるようになり、Journey Optimizerで報告および処理される任意のプロバイダーからフィードバックとインバウンドキーワードの収集を収集できるようになりました。

  • 新規のお客様: こちらの手順に従うと、SMS Webhook を正しく設定できます。

  • 既存のお客様: API 資格情報に保存されている情報から Webhook に移行できます。お客様が移行するタイムラインはありません。 SMS Webhook に移行する既存のお客様の場合は、移行ガイドに記載されているように移行手順を実行する必要があります。

概要 overview

API 資格情報が正常に作成されたら、Webhook を設定して、オプトインおよびオプトアウトの同意を管理するためのインバウンド応答をキャプチャし、利用可能な場合は読み取りレシートを含む配信レポートを受信できるようになりました。

Webhook を設定する際に、取得するデータの種類に基づいて目的を定義できます。

  • インバウンド:オプトインやオプトアウトなどの同意応答を取得し、ユーザーの環境設定を収集する場合は、このオプションを使用します。

  • フィードバック:配信、アウトバウンドエラー、レシートの読み取り(該当する場合)など、レポートと分析をサポートする配信およびエンゲージメントイベントを追跡する場合は、このオプションを選択します。

プロバイダーによっては、SMS の実装を成功させるために設定が必要な事項について、異なる期待事項があります。

  • Sinch と Sinch 会話:インバウンドイベントとフィードバックイベントの両方を処理する 1 つの Webhook を作成します。 ペイロードの設定は不要です。

  • Infobip:インバウンドイベント用とフィードバックイベント用の 2 つの個別の Webhook を作成します。 どちらの Webhook にもペイロード設定は必要ありません。

  • Twilio:Webhook は使用できません。 インバウンドデータとフィードバックデータの収集はサポートされていません。

  • カスタムプロバイダー:インバウンドイベント用とフィードバックイベント用の 2 つの個別の Webhook を作成します。 両方の Webhook が正しく機能するには、ペイロード設定が必要です。

プロバイダーのサポート provider-support

NOTE
サポートされている Webhook 形式は JSON のみです。 Webhook 用のフォームデータはサポートされていません。

次の表に、インバウンドおよびフィードバックの Webhook をサポートするプロバイダーと、ペイロードの作成が必要かどうかを示します。

プロバイダー
インバウンド Webhook
Feedback Webhook
キーワード
ペイロードの作成が必要です
Webhook が必要
ペイロードの作成
Infobip
設定可能
設定可能
設定可能
不要
必須
不要
Sinch
設定可能
設定可能
設定可能
不要
いいえ。統合
なし
Sinch 会話
設定可能
設定可能
設定可能
不要
いいえ。統合
なし
Twilio
なし
なし
なし
なし
なし
なし
カスタム
設定可能
設定可能
設定可能
必須
必須
必須

API 資格情報から SMS Webhook に移行するお客様の場合、移行パスに関する情報は移行ガイドにあります。

Webhook の作成

Sinch および Sinch 会話用 create-webhook-sinch

Sinch および Sinch Conversional の場合、インバウンドイベントとフィードバックイベントの両方を処理する単一の Webhook を作成します。 カスタムペイロード設定は必要ありません。

  1. 左側のパネルで、管理 > チャネル​に移動し、SMS 設定​の下にある SMS Webhook メニューを選択して、「Webhook を作成」ボタンをクリックします。

  2. 以下に説明するように、Webhook 設定を指定します。

    • 名前:Webhook の名前を入力します。

    • SMS ベンダーを選択:Sinch または Sinch 会話。

    • API 資格情報以前に設定した API 資格情報をドロップダウンから選択します。

    • 送信者の電話番号:コミュニケーションに使用する送信者の電話番号を入力します。

  3. キーワードを入力」フィールドにキーワードを入力して、受信キーワードの設定を開始します。 複数のキーワードを追加したり削除したりできます。 キーワードでは大文字と小文字が区別されません。

  4. 受信キーワードカテゴリ ドロップダウンからキーワードカテゴリを選択して、設定します。

    • accordion
      Opt-In
      • ユーザーの同意を得てオプトインするキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードと一致すると、ユーザーの電話番号は SMS メッセージの受信をオプトインします。

      • デフォルトでは、Subscribe、Yes、Unstop、Continue、Resume、Begin の各キーワードが有効になっています。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーのインバウンドメッセージがオプトインキーワードに一致した場合に自動的に送信されるメッセージを作成できます。

    • accordion
      オプトアウト
      • ユーザーをオプトアウトし、テキストメッセージの送信に対する同意を削除するキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードと一致すると、ユーザーの電話番号は SMS メッセージの受信からオプトアウトされます。

      • デフォルトでは、次のキーワードが有効です。Stop、Quit、Cancel、End、Unsubscribe、No。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーの受信メッセージがオプトアウトキーワードと一致した場合に自動的に送信されるメッセージを作成できます。

      • ファジーロジック を有効にして、設定済みのオプトアウトキーワードに類似したキーワードを検出します。 ユーザーの応答が近くても正確でない場合、「あいまい自動応答 フィールドに入力されたメッセージが送信され す。 通常、このメッセージはオプトアウトが発生しなかったことを示し、登録解除に必要な正確なキーワードを指定します。

    • accordion
      ダブルオプトイン
      • ダブルオプトイン要件のキーワードを有効にします。 ユーザーのメッセージが設定済みのキーワードに一致する場合、この段階では完全にオプトインされていません。 この 2 つの手順による同意ワークフローでは、ユーザーが 2 つ目のキーワードでオプトインを確認する必要があります。

      • 返信メッセージ」フィールドを使用すると、ダブルオプトインキーワードが一致した場合に自動的に送信されるメッセージを作成できます。 このメッセージは、オプトインプロセスを完了するためにオプトインキーワードを入力するようにユーザーに指示します。

    • accordion
      ヘルプ
      • ヘルプが要求されたときに標準的な応答を提供するキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードに一致すると、ユーザーはヘルプ返信メッセージを受け取ります。

      • デフォルトでは、「Help」、「Info」、「Information」の各キーワードが有効になっています。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーの受信メッセージがヘルプキーワードと一致した場合に自動的に送信されるメッセージを作成できます。

    • accordion
      カスタム
      • 単一のカスタムキーワードを設定します。 ユーザーのメッセージがこのキーワードに一致すると、キーワードは、レポートとオーディエンス構築のために メッセージフィードバックトラッキング データセットに書き込まれます。

      • ジャーニーやキャンペーンで使用するためにこのキーワードを参照するオーディエンス(ストリーミングまたはバッチ)を作成します。

  5. デフォルトの返信メッセージ を入力します。 このメッセージは、ユーザーの応答が設定されたキーワードに一致しない場合に自動的に送信されます。

  6. 送信」をクリックして、Webhook 設定を保存します。

  7. Webhook メニューから、既存の Webhook を編集または削除できます。

  8. 新しく作成した Webhook にアクセスし、Webhook URL をコピーします。

  9. Webhook URL を使用して、フィードバック イベントと インバウンド イベントをJourney Optimizerに取り込みます。

    • SMS チャネルの場合は、Sinch ドキュメントを参照 ​ てください。

    • MMS チャネルの場合は、Sinch ドキュメントを参照 ​ てください。

    • Journey Optimizer経由で SMS を直接購入したお客様の場合は、Adobe サポートにサポートチケットを提出します。 Adobe アカウントチームが Webhook URL を設定します。

Webhook が、既存のチャネル設定に添付された API 認証情報を使用している場合、Webhook は直ちに有効になります。 それ以外の場合は、新しいチャネル設定を作成します。

➡️​ 詳しくは、チャネル設定を参照してください ​

Infobip の場合 create-webhook-infobip

Infobip の場合、2 つの個別の Webhook を作成します。1 つはフィードバックイベント用、もう 1 つはインバウンドイベント用です。

  1. 左側のパネルで、管理 > チャネル​に移動し、SMS 設定​の下にある SMS Webhook メニューを選択して、「Webhook を作成」ボタンをクリックします。

  2. 以下に説明するように、Webhook 設定を指定します。

    • 名前:Webhook の名前を入力します。

    • SMS ベンダーを選択:Infobip。

    • タイプ:「フィードバック」または「インバウンド」を選択します。 両方を別々に作成する必要があります。ここでは、インバウンドから始めます。

    • API 資格情報以前に設定した API 資格情報をドロップダウンから選択します。

    • 送信者の電話番号:コミュニケーションに使用する送信者の電話番号を入力します。

  3. キーワードを入力」フィールドにキーワードを入力して、受信キーワードの設定を開始します。 複数のキーワードを追加したり削除したりできます。 キーワードでは大文字と小文字が区別されません。

  4. 受信キーワードカテゴリ ドロップダウンからキーワードカテゴリを選択して、設定します。

    • accordion
      Opt-In
      • ユーザーの同意を得てオプトインするキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードと一致すると、ユーザーの電話番号は SMS メッセージの受信をオプトインします。

      • デフォルトでは、Subscribe、Yes、Unstop、Continue、Resume、Begin の各キーワードが有効になっています。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーのインバウンドメッセージがオプトインキーワードに一致した場合に自動的に送信されるメッセージを作成できます。

    • accordion
      オプトアウト
      • ユーザーをオプトアウトし、テキストメッセージの送信に対する同意を削除するキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードと一致すると、ユーザーの電話番号は SMS メッセージの受信からオプトアウトされます。

      • デフォルトでは、次のキーワードが有効です。Stop、Quit、Cancel、End、Unsubscribe、No。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーの受信メッセージがオプトアウトキーワードと一致した場合に自動的に送信されるメッセージを作成できます。

      • ファジーロジック を有効にして、設定済みのオプトアウトキーワードに類似したキーワードを検出します。 ユーザーの応答が近くても正確でない場合、「あいまい自動応答 フィールドに入力されたメッセージが送信され す。 通常、このメッセージはオプトアウトが発生しなかったことを示し、登録解除に必要な正確なキーワードを指定します。

    • accordion
      ダブルオプトイン
      • ダブルオプトイン要件のキーワードを有効にします。 ユーザーのメッセージが設定済みのキーワードに一致する場合、この段階では完全にオプトインされていません。 この 2 つの手順による同意ワークフローでは、ユーザーが 2 つ目のキーワードでオプトインを確認する必要があります。

      • 返信メッセージ」フィールドを使用すると、ダブルオプトインキーワードが一致した場合に自動的に送信されるメッセージを作成できます。 このメッセージは、オプトインプロセスを完了するためにオプトインキーワードを入力するようにユーザーに指示します。

    • accordion
      ヘルプ
      • ヘルプが要求されたときに標準的な応答を提供するキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードに一致すると、ユーザーはヘルプ返信メッセージを受け取ります。

      • デフォルトでは、「Help」、「Info」、「Information」の各キーワードが有効になっています。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーの受信メッセージがヘルプキーワードと一致した場合に自動的に送信されるメッセージを作成できます。

    • accordion
      カスタム
      • 単一のカスタムキーワードを設定します。 ユーザーのメッセージがこのキーワードに一致すると、キーワードは、レポートとオーディエンス構築のために メッセージフィードバックトラッキング データセットに書き込まれます。

      • ジャーニーやキャンペーンで使用するためにこのキーワードを参照するオーディエンス(ストリーミングまたはバッチ)を作成します。

  5. デフォルトの返信メッセージ を入力します。 このメッセージは、ユーザーの応答が設定されたキーワードに一致しない場合に自動的に送信されます。

  6. 送信」をクリックして、Webhook 設定を保存します。

  7. Webhook メニューで、Infobip 用の フィードバック Webhook を作成する必要があります。

  8. 以下に説明するように、Webhook 設定を指定します。

    • 名前:Webhook の名前を入力します。

    • SMS ベンダーを選択:Infobip。

    • タイプ:「フィードバック」を選択します。

  9. 送信」をクリックして、フィードバック Webhook の設定を保存します。

  10. Webhook メニューから、既存の Webhook を編集または削除できます。

  11. 新しく作成した Webhook にアクセスし、各 Webhook から Webhook URL をコピーします。

  12. これらの URL を使用して、両方のコールバック URL でフィードバックとインバウンドイベントをJourney Optimizerに取り込めるようになりました。

Webhook が、既存のチャネル設定に添付された API 認証情報を使用している場合、Webhook は直ちに有効になります。 それ以外の場合は、新しいチャネル設定を作成します。

➡️​ 詳しくは、チャネル設定を参照してください ​

カスタムプロバイダーの場合 create-webhook-custom

カスタム SMS プロバイダーの場合、2 つの異なる Webhook を作成します。1 つはフィードバックイベント用、もう 1 つはインバウンドイベント用です。

  1. 左側のパネルで、管理 > チャネル​に移動し、SMS 設定​の下にある SMS Webhook メニューを選択して、「Webhook を作成」ボタンをクリックします。

  2. 以下に説明するように、Webhook 設定を指定します。

    • 名前:Webhook の名前を入力します。

    • SMS ベンダーを選択:カスタム。

    • タイプ:「フィードバック」または「インバウンド」を選択します。 両方を別々に作成する必要があります。ここでは、インバウンドから始めます。

    • API 資格情報以前に設定した API 資格情報をドロップダウンから選択します。

    • 送信者の電話番号:コミュニケーションに使用する送信者の電話番号を入力します。

  3. キーワードを入力」フィールドにキーワードを入力して、受信キーワードの設定を開始します。 複数のキーワードを追加したり削除したりできます。 キーワードでは大文字と小文字が区別されません。

  4. 受信キーワードカテゴリ ドロップダウンからキーワードカテゴリを選択して、設定します。

    • accordion
      Opt-In
      • ユーザーの同意を得てオプトインするキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードと一致すると、ユーザーの電話番号は SMS メッセージの受信をオプトインします。

      • デフォルトでは、Subscribe、Yes、Unstop、Continue、Resume、Begin の各キーワードが有効になっています。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーのインバウンドメッセージがオプトインキーワードに一致した場合に自動的に送信されるメッセージを作成できます。

    • accordion
      オプトアウト
      • ユーザーをオプトアウトし、テキストメッセージの送信に対する同意を削除するキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードと一致すると、ユーザーの電話番号は SMS メッセージの受信からオプトアウトされます。

      • デフォルトでは、次のキーワードが有効です。Stop、Quit、Cancel、End、Unsubscribe、No。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーの受信メッセージがオプトアウトキーワードと一致した場合に自動的に送信されるメッセージを作成できます。

      • ファジーロジック を有効にして、設定済みのオプトアウトキーワードに類似したキーワードを検出します。 ユーザーの応答が近くても正確でない場合、「あいまい自動応答 フィールドに入力されたメッセージが送信され す。 通常、このメッセージはオプトアウトが発生しなかったことを示し、登録解除に必要な正確なキーワードを指定します。

    • accordion
      ダブルオプトイン
      • ダブルオプトイン要件のキーワードを有効にします。 ユーザーのメッセージが設定済みのキーワードに一致する場合、この段階では完全にオプトインされていません。 この 2 つの手順による同意ワークフローでは、ユーザーが 2 つ目のキーワードでオプトインを確認する必要があります。

      • 返信メッセージ」フィールドを使用すると、ダブルオプトインキーワードが一致した場合に自動的に送信されるメッセージを作成できます。 このメッセージは、オプトインプロセスを完了するためにオプトインキーワードを入力するようにユーザーに指示します。

    • accordion
      ヘルプ
      • ヘルプが要求されたときに標準的な応答を提供するキーワードを有効にします。 ユーザーのメッセージが設定されたキーワードに一致すると、ユーザーはヘルプ返信メッセージを受け取ります。

      • デフォルトでは、「Help」、「Info」、「Information」の各キーワードが有効になっています。 「 」をクリックして、デフォルトのキーワードを削除します。

      • 返信メッセージ」フィールドを使用すると、ユーザーの受信メッセージがヘルプキーワードと一致した場合に自動的に送信されるメッセージを作成できます。

    • accordion
      カスタム
      • 単一のカスタムキーワードを設定します。 ユーザーのメッセージがこのキーワードに一致すると、キーワードは、レポートとオーディエンス構築のために メッセージフィードバックトラッキング データセットに書き込まれます。

      • ジャーニーやキャンペーンで使用するためにこのキーワードを参照するオーディエンス(ストリーミングまたはバッチ)を作成します。

  5. デフォルトの返信メッセージ を入力します。 このメッセージは、ユーザーの応答が設定されたキーワードに一致しない場合に自動的に送信されます。

  6. プロバイダーから得られる JSON に一致するカスタムペイロードを作成します。 サポートされている Webhook 形式は JSON のみです。 Webhook 用のフォームデータはサポートされていません。

    インバウンド Webhook では、プロバイダーの Webhook から値を受け取るために次のフィールドが必要です。

    • InboundMessage:ユーザーから受信した受信メッセージまたはキーワードです。
    • ProfileNumber:メッセージを送信したユーザーの電話番号。
    • リクエスト ID:特定のトランザクションを識別するために SMS プロバイダーが提供する一意の ID。
    • OriginTimestamp:メッセージを受信した際のタイムスタンプ(UTC 形式)。
    • InboundNumber:この Webhook 設定に使用される電話番号。
    accordion
    ペイロードの例
    code language-none
    ```json
    {
    "inboundMessage": "{{inboundMessage}}",
    "profileNumber": "{{profileNumber}}",
    "requestId": "{{requestId}}",
    "originTimestamp": "{{originTimestamp}}",
    "inboundNumber": "{{inboundNumber}}"
    }
    ```
    
  7. JSON ファイルが作成されたら、ペイロードエディターを表示 をクリックし、JSON ペイロードをコピーしてエディターに貼り付け、保存します。

  8. 送信」をクリックして、Webhook 設定を保存します。

  9. Webhook メニューで、カスタムプロバイダーの フィードバック Webhook を作成する必要があります。

  10. 以下に説明するように、Webhook 設定を指定します。

    • 名前:Webhook の名前を入力します。

    • SMS ベンダーを選択:カスタム。

    • タイプ:「フィードバック」を選択します。

  11. プロバイダーの JSON 形式に一致するカスタムペイロードを作成します。 サポートされている Webhook 形式は JSON のみです。 Webhook 用のフォームデータはサポートされていません。

    フィードバック Webhook には、プロバイダーの Webhook から値を受け取るために次のフィールドが必要です。

    • クライアント参照:ログに記録するためにペイロードで返される一意の ID。
    • コード:SMS プロバイダーから提供された失敗コード。
    • ステータス:SMS プロバイダーから提供された失敗ステータス。
    accordion
    ペイロードの例
    code language-none
    ```json
    {
    "clientReference": "{{client_reference}}",
    "ステータス": [
    {
    "code": "{{failureCode}}",
    "status": "{{feedbackStatus}}"
    }
    ]
    }
    ```
    
  12. ペイロードエディターを表示 をクリックし、JSON ペイロードをコピーしてエディターに貼り付け、保存します。

  13. 送信」をクリックして、フィードバック Webhook の設定を保存します。

  14. Webhook メニューから、既存の Webhook を編集または削除できます。

  15. 新しく作成した Webhook にアクセスし、各 Webhook から Webhook URL をコピーします。

  16. Journey Optimizerのこれらの Webhook URL に Feedback イベントと Inbound イベントを送信するように SMS プロバイダーを設定します。

    設定手順は、SMS プロバイダーによって異なります。 コールバック URL の設定について詳しくは、プロバイダーのドキュメントを参照してください。

Webhook が、既存のチャネル設定に添付された API 認証情報を使用している場合、Webhook は直ちに有効になります。 それ以外の場合は、新しいチャネル設定を作成します。

➡️​ 詳しくは、チャネル設定を参照してください ​

b22c9c5d-9208-48f4-b874-1cefb8df4d76