シナリオ対話API

シナリオ対話APIは、自然対話プラットフォームに登録したシナリオで、シナリオ対話を行えます。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/SpontaneousDialogueServer/dialogue

リクエスト

Method POST
Header Content-Type: application/json;charset=UTF-8
Body JSON形式。 (詳細はリクエストパラメータを参照)

レスポンス

Body JSON形式。(詳細はレスポンスパラメータを参照)

リクエストパラメータ

シナリオ対話に必要な情報です。JSON形式でリクエストします。

キー 必須 説明 
language string ja-JPen-USen-JP、のいずれかを設定します。
ja-JP以外のサポートはボットに依存します)
botId string 対話する対象のボットIDを設定します。
appId string ユーザ登録APIで取得したアプリIDを設定します。
voiceText string ユーザ発話を設定します。
initTalkingFlag boolean 初回の発話時にtrueを設定します。
デフォルトでfalseが設定されています。
initTopicId string クライアント側でtopicを設定する際に使用します。
このキーを使用する際は、initTalkingFlagtrueを設定することを推奨します。
initThat string 前回発話を更新する内容を設定します。
initIdが設定されている場合は、initIdを優先します。
initId string 前回発話IDを更新する内容を設定します。
clientData JSON JSON形式で任意の情報を以下のように2階層で設定します。

xAIML側での取得方法はこちらをご覧ください。

appRecvTime string 発話時刻 アプリが最後にレスポンスを受信した時刻を設定します。
フォーマット:YYYY-MM-DD hh:mm:ss 
appSendTime string 発話時刻 アプリがリクエストを送信した時刻を設定します。
フォーマット:YYYY-MM-DD hh:mm:ss

※キーはスネークケースでも記述することができます。

Example – 1

最小のキー構成のリクエストパラメータです。

Example – 2

クライアントデータを持つリクエストパラメータです。

レスポンスパラメータ

シナリオ対話の結果です。JSON形式でレスポンスされます。

キー 必須 説明 
systemText object システム発話に関する情報を保持します。
  expression string 表示用の文字列です。
  utterance string 音声合成用の文字列です。
<utterance>によって指定された値が設定されます。
(デフォルト値としてexpressionが設定されます)
talkend boolean シナリオ対話の終了フラグです。
<template><li>で指定されたtalkendの値が設定されます。
timeout string 長いシステム主導発話のタイムアウト値です。
command string Base64 URLエンコーディングしたコマンド情報です。
dialogStatus object 意図解釈結果です。
詳細はこちらをご覧ください。
serverSendTime string サーバがレスポンスを送信した時刻です。
フォーマット:YYYY-MM-DD hh:mm:ss
Example – 1

レスポンスパラメータ(エラー)

キー 必須 説明 
error string エラー内容です。
Example

レスポンスコード

コード 意味
200 成功 送信成功
400 エラー パラメーター不正
404 サーバーなし
50x 送信失敗 サーバー内部エラー