この機能はAIエージェントの一部です。

「APIコールを実行する」ステップでは、会話ボットでREST APIリクエストを使用して、ShopifyやSalesforceなどの外部システムからデータを取り込むことができます。

このレシピでは、エンドユーザーによって提供された場所の天気データを取得するボット回答を作成します。ボット回答は、OpenWeather APIからデータを取得します。このレシピで作成した回答フローに基づいて、独自のAPIを使用した回答を作成することができます。

このレシピには以下のタスクが含まれます。
  • タスク1：セットアップの確認
  • タスク2：APIコネクションの作成
  • タスク3：カスタムチケットフィールドの作成
  • タスク4：ボットの回答の作成
  • タスク5：変更点のテスト
メモ：この記事は説明のみを目的として提供されています。Zendeskはこの記事のレシピの例をサポートしません。また、OpenWeather APIのようなサードパーティの技術もサポートしていません。

タスク1：セットアップの確認

このレシピを実行するには、以下のものが必要です。

  • 公開済みの会話ボットがあるZendeskアカウント。必要であれば、本番環境で使用する前に、サンドボックスのテスト環境を使用して会話ボットをテストすることができます。

    Webおよびモバイルのメッセージングチャネルで会話ボットをセットアップするには、「Webチャネルおよびモバイルチャネル用の会話ボットの作成」を参照してください。サンドボックス環境でのメッセージングの使用については、「サンドボックスでZendeskメッセージングを有効にする方法」を参照してください。

  • OpenWeatherアカウントのAPIキー。このレシピで使用するAPIは、OpenWeatherの無料プランで利用できます。

    無料のOpenWeatherアカウントに登録するには、openweathermap.orgの「Create New Account」ページを参照してください。サインイン後に、OpenWeatherのアカウントページでAPIキーを入手することができます。

    OpenWeather APIキーを有効にするには、アカウントのメールアドレスを確認する必要があります。メールアドレスを確認後、APIキーがアクティブになるまで最大で2時間かかることがあります。詳細については、openweathermap.orgのFAQを参照してください。

タスク2：APIコネクションの作成

まず最初に、OpenWeather APIキーを保存するためのAPIコネクションを作成します。会話ボットはこのコネクションを使用して、OpenWeather APIへのコールを認証できます。

コネクションを作成するには
  1. 管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「コネクション」>「コネクション」を選択します。
  2. 「コネクションを作成」をクリックします。
  3. APIキーの認証タイプを選択します。
  4. 「コネクション名」に「openweather_api_key」と入力します。
  5. 「ヘッダー名」に「x-api-key」と入力します。
  6. 「値」にOpenWeather APIキーを入力します。
  7. 「許可されたドメイン」に「api.openweathermap.org」と入力します。
  8. 「保存」をクリックすると、コネクションが作成されます。

タスク3：カスタムチケットフィールドの作成

次に、エンドユーザーから提供された場所を取得するために、カスタムチケットフィールドを作成します。

カスタムチケットフィールドを作成するには
  1. 管理センターで、サイドバーの「 オブジェクトとルール」をクリックし、「チケット」>「フィールド」を選択します。
  2. 「フィールドを追加」をクリックします。
  3. フィールドタイプに「テキスト」を選択します。

  4. 「表示名」に「Location」と入力します。
  5. 「権限」で、「顧客は編集可能」を選択します。
  6. 「カスタマー」で、「顧客に表示されるタイトル」フィールドに「Location」と入力します。
  7. 「保存」をクリックします。

アカウントで1つのチケットフォームを使用している場合は、チケットフォームに自動的に新しいチケットフィールドが表示されます。フィールドを削除するには、「チケットフォームを編集する」を参照してください。

タスク4：ボットの回答の作成

このセクションでは、ボットビルダーで回答を作成し、その目的を設定し、回答のステップを追加する方法を説明します。これには、以下の手順が含まれます。

  • ステップ1：回答を作成する
  • ステップ2：回答の目的を設定する
  • ステップ3：最初のメッセージのステップを追加する
  • ステップ4：エンドユーザーに場所を尋ねる
  • ステップ5：その場所の気象データを取得する
  • ステップ6：エンドユーザーに天気予報のメッセージを送信する
  • ステップ7：失敗メッセージを追加する
  • ステップ8：更新したボットを公開する

ステップ1：回答を作成する

ボットビルダーを使用して会話ボットの回答を作成します。

回答を作成するには
  1. 管理センターで、サイドバーにある「 チャネル」をクリックし、「AIエージェントと自動化」>「AIエージェント」を選択します。
  2. 「会話ボットを管理」をクリックします。
  3. 作業したい会話ボットをクリックします。
  4. 「回答」タブで、「回答を作成」をクリックします。

ステップ2：回答の目的を設定する

回答の目的とトレーニング用の表現を設定します。これには、会話の中で答えを引き出すための語句や単語も含まれます。

回答の目的を設定するには
  1. ボットの編集ページの「回答」タブで、「回答を作成」をクリックします。
  2. 「独自の回答を作成」をクリックして、「次へ」をクリックします。
  3. 回答の「目的」に「Get weather」と入力します。
  4. 「トレーニング用の表現」で、「Get weather forecast」および「Get current temperature」と入力します。
  5. 「次へ」をクリックします。

    回答がボットビルダーで開き、そこで回答を作成することができます。

ステップ3：最初のメッセージのステップを追加する

ユーザーに場所を尋ねるための「メッセージの送信」ステップを追加します。これは、回答のフローの最初のステップです。

最初のメッセージステップを追加するには
  1. ボットビルダーで「ステップを追加」をクリックします。
  2. 「ステップの選択」で、「メッセージの送信」を選択します。
  3. 「ボットメッセージ」に、次のテキストを入力します。 
    
        What location would you like to get the weather for?

Include the country code. For example: "Melbourne, AU" or  "San Francisco, US"

ステップ4：エンドユーザーに場所を尋ねる

最初のメッセージの後、エンドユーザーに基本的なフォームを提示するために、「詳細を質問する」ステップを追加します。このフォームには、チケットフィールドの「Location」値のためのテキストボックスが含まれています。

「詳細を質問する」ステップを追加するには
  1. ボットビルダーで、ステップを追加アイコン（）をクリックします。
  2. 「ステップの選択」で、「詳細を質問する」を選択します。
  3. 「名前」に「Get location」と入力します。
  4. 「フィールド」で、「Location」チケットフィールドと入力して選択します。

ステップ5：その場所の気象データを取得する

OpenWeather APIのCurrent weather dataエンドポイントから、その場所の天気データを取得するために、「APIコールを実行する」ステップを追加します。

「APIコールを実行する」ステップを追加するには
  1. ボットビルダーで「ステップを追加」をクリックします。
  2. 「ステップの選択」で、「APIコールを実行する」を選択します。
  3. 「名前」に「Get weather」と入力します。
  4. 「APIの詳細」で、「エンドポイントURL」に https://api.openweathermap.org/data/2.5/weather?units=metric&q= と入力します。
  5. 変数を追加アイコン（）を使用して、「Location」フィールドの変数を「エンドポイントURL」の値に追加します。

    完成したエンドポイントURLの値は、以下のようになります。

  6. 「認証」で、openweather_apiコネクションを選択します。
  7. 「APIコールを実行する」をクリックして、APIリクエストをテストします。
  8. 「テストデータ」で、「場所」に「Melbourne, AU」を入力します。
  9. 「APIコールを実行する」をクリックします。
  10. 以下の変数をデフォルト名で保存します。
    • main > temp
    • weather > item 1 > description

ステップ6：エンドユーザーに天気予報のメッセージを送信する

天気データを取得したら、「メッセージの送信」ステップで天気データを含めたメッセージを返信します。

「APIコールに成功」メッセージを追加するには
  1. ボットビルダーで、「Get weather」ステップの「APIコールに成功」分岐にある「ステップを追加」をクリックします。
  2. 「ステップの選択」で、「メッセージの送信」を選択します。
  3. 「ボットメッセージ」に、次のテキストを入力します。 
    
        It's {{temp}}° C with {{description}} in
  4. 変数を追加アイコン（）を使用して、「Location」フィールドの変数を「ボットメッセージ」の値に追加します。次に、ピリオド（.）を追加します。

    完成した「ボットメッセージ」の値は、次のようになります。

ステップ7：失敗メッセージを追加する

「APIコールを実行する」ステップで行ったリクエストは、失敗することもあります。たとえば、存在しない場所がリクエストに含まれている場合などです。「メッセージの送信」ステップをAPIコール失敗分岐に追加します。このステップは、OpenWeather APIコールが失敗した場合にメッセージを返します。

API失敗メッセージを追加するには
  1. ボットビルダーで、「Get weather」ステップの「APIコールに失敗」分岐にある「ステップを追加」をクリックします。
  2. 「ステップの選択」で、「メッセージの送信」を選択します。
  3. 「ボットメッセージ」に、次のテキストを入力します。 
    
        I'm sorry. I wasn't able to get weather data for
  4. 変数を追加アイコン（）を使用して、「Location」フィールドの変数を「ボットメッセージ」の値に追加します。次に、ピリオド（.）を追加します。

    完成した「ボットメッセージ」の値は、次のようになります。

ステップ8：更新したボットを公開する

回答をライブにするには、更新したボットを公開します。

ボットを公開するには
  1. ボットビルダーの右上隅にある「完了」をクリックします。
  2. ボットページで、「ボットを公開」をクリックします。
  3. 「公開」をクリックします。

タスク5：変更点のテスト

変更を公開したら、更新したボットとの会話で「How’s the weather?」と尋ねて、新しい回答をテストできます。会話ボットのテストについての詳細は、「エンドユーザーのメッセージングエクスペリエンスのテスト」を参照してください。

Powered by Zendesk