自動ガイドボットにおけるWebhookの処理の設定

自動ガイドボットにおけるWebhookの処理の設定

自動ガイドボットのフローにWebhookブロックを追加すると、自動ガイドボットの処理を、Zoho Desk内の処理や他のサービス（他のZohoサービス、外部サービス）の処理と連携できます。たとえば、連携している処理やサービスから取得したデータを自動ガイドボットの内容に反映したり、自動ガイドボットで顧客から得られた情報を他のサービスに登録したりできます。これらのサービスとの連携は、APIを通じて行われます。そのため、APIを通じてアクセスできるデータや、APIを利用して実行される処理なら、Webhookの処理を通じて自動ガイドボットと連携させることが可能です。

使用例

横浜さんは、自身がジルカー社から購入したタブレット端末（zPad）の画面が破損していることに気がつき、商品の販売元であるジルカー社のWebサイトから交換を依頼することにしました。横浜さんの購入情報は売上履歴に記録されていたため、WebhookブロックによってAPIが実行され、データベースから横浜さんの名前とメールアドレスが取得されました。また、Zoho Deskアカウントの連絡先には、横浜さんの情報が登録されていたため、ボット（自動応答ロボット）は連絡先の新規登録は行わずに、問い合わせ番号を発行して、横浜さんに問い合わせの受付完了メールを送信しました。横浜さんのケースとは異なり、問い合わせを行ったユーザーが連絡先として登録されていない場合は、ボットはユーザーをZoho Deskアカウントの連絡先に登録してから、問い合わせ番号を発行します。以上の使用例では、Webhookブロックによって、サポート対象のユーザーがZoho Deskアカウントの連絡先に登録済みであるかどうかを確認してから問い合わせに対応することで、問い合わせをより効率的に処理できています。

Webhookブロックの追加

フローにWebhookブロックを追加するには、次の手順を実行します。
  1. ［設定］ → ［一般］ → ［自動ガイドボット］ に移動します。
  2. Webhookブロック を追加したい フロー を選択します。
  3. 自動ガイドボットの編集画面で、 ［ブロックを追加する］ ボタン（ ）をクリックします。
    画面右側に     ブロック追加用の設定画面 が表示されます。
  4. この画面で ［処理ブロック］ を選択し、 ［Webhook］ を選択します。



  5. 表示されたWebhookの設定画面で、以下の詳細を入力します。
    1. ブロック名 ：ブロック名を入力します。例：連絡先の取得処理
    2. メソッド ：APIの実行のためのメソッドの種類を一覧から選択します。
      1. GET ：既存のデータを取得します。
      2. PATCH ：既存のデータの一部を更新します。
      3. POST ：データを作成するか、既存のデータを更新します。
      4. PUT ：データの一部を修正します。
      5. DELETE ：既存のデータを削除します。
        このAPIの実行後、WebhookのURLは処理に関する情報の受信を停止します。
    3. URL に外部アプリのREST APIのURLを入力します。
  6. クエリーのパラメーター の項目をクリックして、データの並び替えやフィルターの条件を入力します。例：@email
  7. APIの実行を選択した場合、ヘッダーとして組織IDまたはポータルIDを入力します。組織ID／ポータルIDは、 ヘッダー の値として送信される必要があります。
    APIの実行では、このポータルIDから処理が実行されます。



  8. 本文のセクションでは、 JSON を選択して項目を追加するか、 ファイルのアップロード を選択してファイルをアップロードします。
    1. JSON を選択した場合は、次の設定を行います。
      1. 必須の変数： APIドキュメントで必須の変数を追加します。これらの項目は、Zohoサービスまたは外部サービスのポータルで有効になっており、自動ガイドボットの要素と関連付けられている必要があります。変数の値を入力するには、変数と「@」記号を入力し、選択リストの中から変数の値を選択します。
      2. カスタム項目： 本文のセクションに、必要に応じて、連携する外部サービスやZohoサービスのポータルで有効なカスタム項目を入力します。
    2. ファイルのアップロード を選択した場合は、次の設定を行います。
      1. アップロードファイル用の キー と 値 を入力します。
  9. ［保存する］ をクリックします。
  10. Zoho Deskのポータルとの ［連携］ を設定するには、次のいずれかを選択します。
    1. サービスを選択： 既存のサービスと連携します
    2. 独自サービス： 新しい連携を設定します

リクエスト本文（ボディ）のパラメーターについての注意事項：
  1. GET メソッドでは、リクエスト本文（ボディ）を通じてデータを送信することはできません。
  2. 本文のセクションで宣言した値には、顧客から取得するデータが設定されるようにします。そうでない場合は、本文のセクションで変数の初期値を設定する必要があります。変数に@記号を設定した場合、情報はチャットを通じて取得されるため、@記号の変数には、自動ガイドボットで顧客が入力した値が設定されます。
  3. オレンジ色で表示されている他のすべての値は固定値であるため、値として顧客の入力内容を適用することはできません。これらの項目または変数については、設定済みの値が適用されます。

サービスの選択

既存のサービスとの連携を設定するには、次の手順を実行します。
  1. Webhookブロックの追加 の手順1から手順9までを実行します。
  2. 連携のラベルの隣に表示されている ［追加する］ をクリックします。
    Delugeを通じた連携設定 （DRE：Deluge Runtime Environment）のページが新しいタブで開きます。
  3. ［サービスを選択］ で、すでに連携が有効になっている外部サービスまたはZohoサービスを選択します。
  4. 連携と連携用リンクの 名前 を入力します。
    メモ： メッセージが表示されたら、サービスの 適用範囲 を選択する必要があります。
  5. ［作成して接続する］ をクリックします。
  6. 組織／ポータルからワークフローに連携できるようにするには、 ［承諾する］ をクリックします。
    連携の概要に関する画面は、以下のように表示されます。



  7. Webhookブロックの画面の ［連携］ のセクションで、選択リストに連携名を反映させるには ［更新する］ をクリックします。
  8. ［サービスを選択］の選択リストから、 連携名 を選択します。
  9. 応答のセクションで ステータス番号（ステータスコード） をクリックして次の操作を実行します。
    1. APIドキュメントから取得する ステータス番号 を入力します。
      ステータス番号に合う変数が自動で生成されます。
    2. ボットの変数 、 応答の値 、 種類 、 データの種類 を含む応答の値を入力します。
    3. プラス アイコン（ ）をクリックすると、ボットの変数を追加できます。
    4. ［保存する］ をクリックします。
      別のステータス番号を追加して、対応するボットの変数を追加する場合は、 ［新しい応答を追加する］ をクリックします。
  10. リクエストの制限時間を設定します。
    初期設定の制限時間は8秒です。
  11. Webhookブロックで ［保存する］ をクリックします。
  12. 設定を保存するには、フローで ［下書きを保存する］ をクリックします。
  13. フローが正常に動作するかを確認するには、 ［プレビュー］ をクリックします。
Webhookブロックの右上に表示されている ［コピー］ ／ ［削除］ をクリックすると、Webhookブロックをコピー／削除できます。

独自サービス

新しい連携を最初から作成するには、次の手順を実行します：
  1. Webhookブロックの追加 の手順1から手順9までを実行します。
  2. 連携のラベルの隣に表示されている ［追加する］ をクリックします。
    Delugeを通じた連携設定 （DRE：Deluge Runtime Environment）のページが新しいタブで開きます。
  3. 独自サービス のタブを選択します。



  4. 独自の連携設定ページで、次の詳細を入力します。
    1. サービス名
    2. サービスリンク名
    3. 認証の種類 - 接続のための認証の種類を選択します
    4. パラメーターの種類
    5. 連携名
    6. 連携リンク名
  5. ［作成して連携する］ をクリックします。
  6. 組織／ポータルから連携できるようにするには、 ［承諾する］ をクリックします。
    連携の概要に関する画面が表示されます。
  7. Webhookブロックの画面の ［外部連携］ のセクションで、選択リストに連携の名前を反映させるには ［更新する］ をクリックします。
  8. ［サービスを選択］の選択リストから、 連携 名 を選択します。
  9. 応答のセクションで ステータス番号（ステータスコード） をクリックして次の操作を実行します。
    1. APIドキュメントから取得する ステータス番号 を入力します。
      ステータス番号に合う変数が自動で生成されます。
    2. ボットの変数 、 応答の値 、 種類 、 データの種類 を含む応答の値を入力します。
    3. プラス アイコン（ ）をクリックすると、ボットの変数を追加できます。
    4. ［保存する］ をクリックします。
      別のステータス番号を追加して、対応するボットの変数を追加する場合は、       ［新しい応答を追加する］ をクリックします。
  10. リクエストの制限時間を設定します。初期設定の制限時間は8秒です。
  11. Webhookブロックで ［保存する］ をクリックします。
  12. 設定を保存するには、フローで ［下書きを保存する］ をクリックします。
  13. フローが正常に動作するかを確認するには、 ［プレビュー］ をクリックします。
ブロックの右上にある各ボタンをクリックすると、Webhookブロックを コピー または 削除 できます。