外部API連携ボックス

外部API連携ボックスは、ボットと外部のAPIを連携させます。
外部API連携ボックスを利用することで、GUIエディタで簡単にボットから外部のAPIを呼び出すことが可能です。

外部API連携ボックスの配置

操作手順

  1. 左メニューの外部API連携ボックス(1)を画面中央にドラッグ&ドロップすることで利用できます。
    ご注意
    外部API連携ボックスの直前にはユーザ発話ボックスのみ接続でき、直後にはシステム発話ボックスのみ接続できます。

外部API連携ボックスの設定

外部API連携ボックスには以下の4つの情報が設定できます。

入力条件タブ

入力条件タブでは、ユーザ発話ボックスと同じようにマッチングするための条件を指定することができます。

テキストタブ

テキストタブでは、外部API連携ボックスに指定されたAPIにリクエスト送信したあと、ボットが発話する内容を設定できます。

応答を発話

  • リクエスト成功時は、APIからのレスポンスをそのままボットが発話します。
  • エラー発生時、「エラー発生時の応答」に設定した内容をボットが発話します。

発話しない

  • リクエストが成功しても、エラーが発生してもボットは発話しません。

リクエスト情報タブ

リクエスト情報タブでは、APIのリクエスト情報を設定できます。

リクエストメソッド、リクエストURL、リクエストヘッダー、リクエストボディの4つの情報を設定してください。

設定例

かたらいお試しAPIのユーザ登録に接続する場合、以下のリクエスト情報を設定します。

リクエストメソッドを指定してください

POST

リクエストURLを指定してください

https://api-katarai-trial.xaiml.docomo-dialog.com/registration

リクエストヘッダーを指定してください

リクエストボディを指定してください

保存するレスポンス情報タブ

保存するレスポンス情報タブでは、APIのレスポンス情報を変数に保存できます。

「覚えた内容」に任意の変数を指定し、「覚える内容」にレスポンス内の覚えさせたい内容を指定することで、任意の変数にレスポンスの情報を保存することができます。

設定例

以下のAPIレスポンスの場合、覚える内容には以下を設定します。
※詳しくはこちらをご覧ください。

APIレスポンス
覚える内容の設定