Webhookブロックのクエリーパラメーター

Webhookブロックのクエリーパラメーター


クエリーパラメーターを使用することで、Webhookのリクエストを送信する際に問い合わせ番号、メールアドレス、ステータスなどの詳細を合わせて送信できます。クエリーパラメーターをもとに、外部アプリ/システムに対して対象となるデータを指示することが可能です。

以下では、Webhookブロックのクエリーパラメーターの概要や使用例について説明します。



クエリーパラメーターとは 

クエリーパラメーターとは、APIのURLの末尾に追加されるキーと値の組み合わせを表します。クエリーパラメーターを指定することで、対象の外部アプリ/システムのサーバーに対して対象となるデータを指示できます。

クエリーパラメーターを指定したURLの例は、以下のとおりです。

この例の場合のキーと値は以下のとおりです。
  1. キー:ticketId
  2. 値:12345
以下のように、アンパサンド(&)を使用して複数のクエリーパラメーターを指定することも可能です。

この例では、問い合わせ番号が「12345」、ステータスが「未完了」、優先度が「高」の問い合わせが指定されています。



クエリーパラメーターの利点 

クエリーパラメーターの利点は、以下のとおりです。
  1. 特定のデータのみを取得できる
  2. ステータス、優先度、日付などの条件をもとにデータを抽出できる
  3. チャットボットのセッションにおいて、特定のチャットの利用者や問い合わせに関する情報を動的に出力できる
  4. リクエストボディで不要な情報を送信しなくても済む

クエリーパラメーターの追加場所 

ボットの会話フローのWebhookブロックの画面で、クエリーパラメーターを追加できます。こちらの画面で、キーと値の組み合わせを入力することが可能です。

クエリーパラメーターの例は、以下のとおりです。
  1. キー:ticketId
  2. 値: @ticket.id
  3. このクエリーパラメーターによって問い合わせ番号が指定され、APIを通じて対象のデータが動的に出力されます。
 1件のWebhookのリクエストに対して追加可能なクエリーパラメーターの上限は、20件です。 
 
使用例
使用例
1.外部アプリ/システムから特定の問い合わせの詳細を取得する

クエリーパラメーター:
  1. キー:ticketId
  2. 値: {{ticket.id}}
最終的なリクエストの値:
 
2.現在のステータスが「未完了」の問い合わせのみを取得する

クエリーパラメーター:
  1. キー:status
  2. 値: Open
最終的なリクエストの値:
 
3.複数の詳細を取得する
Zoho Deskのなどのサービスの一部のAPIでは、基準となるリクエストに加えて[連絡先]や[商品]などの関連タブを含めることができます。

例:

このリクエストでは、問い合わせの情報に加えて、問い合わせに関連付けられている以下の情報を取得することが可能です。
  1. 連絡先
  2. 商品
  3. 担当者
  4. 部門、チーム

クエリーパラメーターのメリット 


  1. APIのリクエストを簡潔にできます
  2. 必要なデータをのみを取得できます
  3. 変数を使用してチャットの利用者の入力内容を挿入することで、動的なデータを取得できます
  4. ほとんどのREST APIに対応しています


使用に関するヒント 


  1. 対応しているパラメーターについては、該当のサービスのAPIドキュメントをご参照ください。
  2. {{ticket.id}}、{{user.email}}などの変数を使用し、リクエストをカスタマイズできます。
  3. クエリーパラメーターは必須ではありませんが、とても役立つ機能です。特定のデータを抽出したい場合は、クエリーパラメーターを指定することをお勧めします。



    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



            Zoho Campaigns Resources

              Zoho WorkDrive Resources




                • Desk Community Learning Series


                • Digest


                • Functions


                • Meetups


                • Kbase


                • Resources


                • Glossary


                • Desk Marketplace


                • MVP Corner


                • Word of the Day


                • Ask the Experts









                                Resources

                                Videos

                                Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                eBooks

                                Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                Webinars

                                Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                CRM Tips

                                Make the most of Zoho CRM with these useful tips.