Webhook の設定

Webhook は、パートナーが作成した HTTPS コールバックで、エージェントがメッセージやイベントに応答する方法を指定します。Dialogflow などの事前構築済みの自動ソリューションを使用している場合を除き、エージェントの動作を定義するカスタム Webhook を設定する必要があります。

パートナー レベルとエージェント レベルの Webhook

Webhook は、パートナー レベルまたはエージェント レベルで設定できます。パートナー レベルの Webhook は管理するすべてのエージェントに適用され、エージェント レベルの Webhook はそれぞれ 1 つのエージェントに適用されます。

異なる動作で複数のエージェントを操作する場合は、エージェント レベルの設定を使用して、エージェントごとに異なる Webhook を設定できます。一方、エージェントが同様の動作をする場合や、エージェントが 1 つのみの場合は、パートナー レベルの Webhook を使用できます。

パートナー レベルの Webhook とエージェント レベルの Webhook の両方が設定されている場合、エージェント レベルの Webhook は特定のエージェントで優先され、パートナー レベルの Webhook はエージェント レベルの Webhook が設定されていないエージェントに適用されます。

パートナー レベルの Webhook を設定する

パートナー レベルの Webhook を設定する手順は次のとおりです。

  1. Business Communications Developer Console を開き、ビジネス メッセージの Google アカウントでログインします。
  2. アカウント設定を開きます。
  3. 正しいパートナー アカウントが選択されていることを確認します。
  4. [Business Messages Webhook URL] で、[Configure] をクリックします。
  5. [Webhook endpoint URL] にアプリケーションの URL と「/callback/」を入力します。たとえば、「https://PROJECT_ID.appspot.com/callback/」のようになります。
  6. clientToken の値をメモします。メールの受信が Google からのものであることを確認するために必要です。
  7. 指定された clientToken パラメータで POST リクエストを受け入れ、シークレット パラメータの書式なしテキスト値を含む 200 OK レスポンスをレスポンス本文として送信するように Webhook を構成します。たとえば、Webhook が次の本文を含む POST リクエストを受け取ったとします。

    {
    "clientToken":"SJENCPGJESMGUFPY",
      "secret":"0123456789"
    }
    

    その場合、Webhook は clientToken 値を確認し、clientToken が正しい場合は、レスポンス本文として 0123456789 を使用して 200 OK レスポンスを返します。

  8. コンソールで [確認] をクリックします。ビジネス メッセージによって Webhook の確認が完了すると、ダイアログが終了します。

エージェント レベルの Webhook を設定する

パートナー レベルの Webhook でエージェントに送信されたメッセージを受信できます。特定のエージェントのメッセージが別の Webhook に到着するようにするには、エージェント レベルの Webhook を設定します。

  1. Business Communications Developer Console を開き、ビジネス メッセージの Google アカウントでログインします。
  2. エージェントをクリックします。
  3. [Integrations] をクリックします。
  4. [Webhook] で [Configure] をクリックします。
  5. [Webhook endpoint URL] に「https://」で始まる Webhook の URL を入力します。
  6. clientToken の値をメモします。これは、受信したメールが Google から届いたことを確認するために必要です。
  7. 指定された clientToken パラメータで POST リクエストを受け入れ、secret パラメータの値で 200 OK レスポンスを送信するように Webhook を構成します。たとえば、Webhook が次の本文を含む POST リクエストを受け取ったとします。

    {
      "clientToken":"SJENCPGJESMGUFPY",
      "secret":"0123456789"
    }
    

    その場合、Webhook は clientToken 値を確認し、clientToken が正しい場合は、シークレット URL パラメータを 0123456789 に設定して 200 OK レスポンスを返します。

  8. コンソールで [確認] をクリックします。ビジネス メッセージによって Webhook の確認が完了すると、ダイアログが終了します。