フォームで API タスクを設定する

API Task を呼び出すフォームを作成して設定し、API Task 変数をフォームの必須フィールドにマッピングします。

前提条件

  • Bot Creator ライセンスが必要です。
  • フォームから呼び出すには、まず API Taskを作成する必要があります。
このトピックでは、フォームにおける API Taskの呼び出し方法について説明します。この例では、入力された郵便番号に基づいて place と state の詳細を取得する API Taskを呼び出す郵便番号フォームを作成します。作成したフォームは、プロセスを通して実行されます。自分の事例に特化したフィールドを持つフォームを作成することができます。

手順

  1. API Task を呼び出したい既存のフォームに移動するか、新しいフォームを作成します。詳細については、「フォームの作成」を参照してください。
    このフォームに「API タスク - 郵便番号フォーム」という名前を付けます。
  2. フォームの設計: フォーム要素を使用して、事例に基づいたインタラクティブ フォームを構築します。この例では、フォームは API Taskから郵便番号変数をマッピングするように設計されています。
    1. [要素] 列から、[テキスト ボックス] 要素をドラッグして、フォーム デザイナーにドロップします。
      画面右側に、関連するフィールドとともに [プロパティ] タブが表示されます。
    2. [要素ラベル] に入力します。次に例を示します。たとえば、[郵便番号] です。
    3. [ボタン] 要素をドラッグし、[郵便番号] テキストボックスの下のデザイナーにドロップします。[ボタンのテキスト (必須)] フィールドに、このボタンの名前を [送信] と入力します。
    4. さらに 2 つの [テキスト ボックス] の要素をドラッグして、「場所」と「州」という名前を付けます。
  3. [フォーム ルール] を追加します。フォーム ルールは、フォームの各要素に必要な条件を提供します。フォーム ルールをif 条件およびthen 条件を使用して設定し、条件が満たされたときに実行されるアクションを指定できます。この例では、郵便番号が入力され、[送信] ボタンが押されると、場所と都道府県の要素ボックスが API Task変数から値を取得するようにフォーム ルールが設定されています。実行中に、フォーム ルールの条件が満たされない場合、API Taskは期待通りに動作しません。
    1. [フォーム ルール] タブをクリックします。
    2. 必要に応じて、ルールの名前を入力します(例: API Task 呼び出し)。
    3. ボタンが押された場合に、検証される If 条件を入力します。フォームで API タスクを呼び出す
    4. Then 節を定義するには、[フォーム アクション] を選択し、ドロップダウンから、[API 呼び出しから値を取得] を選択します。
    5. API Task に関連する変数をフォームにマッピングするには、[変数マッピングを追加] オプションを使用します。
      注: タスクをチェックインした後に公開されている API Task を編集して変数を追加した場合、その変数はフォームに表示されません。変数を追加した後で、API Task をチェックインする必要があります。
    6. [参照] をクリックして、固有の API Task を選択し、指定の操作を実行します。この例では、API Task (API タスク - 郵便番号) が選択されており、任意の郵便番号の場所と都道府県を取得できます。