Documentation Powered by ReDoc

シナリオ対話API (2.6)

シナリオ対話API

シナリオ対話

シナリオ対話

スネークケース及びキャメルケースどちらでも問題ない

Request Body schema: application/json;charset=utf-8
language
required
string

指定言語選択。ja-JP、en-US、en-JPのいずれかを指定（ja-JP以外のサポートはボットに依存）

botId
required
string <= 100 characters

ボットID

appId
required
string <= 100 characters

アプリケーションID

initTalkingFlag
boolean

初期発話フラグ(default:false)

initTopicId
string

初期発話トピックID。(default:-)

このキーを使用する場合、initTalkingFlagにtrueを設定することを推奨。

initThat
string

前回発話(default:-)

initIdが指定されている場合、initIdを優先

initId
string

前回発話ID(default:-)

voiceText
required
string <= 200 characters

ユーザ発話

object

クライアント情報。2階層のデータ構造を要する。 clientData.[グループ].[属性名]

xAIML側での取得方法はこちらを参照。

appRecvTime
string

前回システム発話を取得した時刻。YYYY-MM-DD hh:mm:ss

対話タイムアウトを活用する場合に設定。その場合、前回レスポンスの “serverSendTime” の値を設定。

未指定の場合は、リクエストを取得した時点のサーバ時刻が設定される。

appSendTime
string

ユーザ発話を送信した時刻。YYYY-MM-DD hh:mm:ss

対話タイムアウトを活用する場合に設定。

リクエストが送られた時刻を、指定した時刻に変更できる。

未指定の場合は、リクエストを取得した時点のサーバ時刻が設定される。

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "language": "ja-JP",
  • "botId": "DoCoMo_InitBot",
  • "appId": "STT-DoCoMo",
  • "initTalkingFlag": false,
  • "initTopicId": "Food",
  • "initThat": "お昼ご飯何が食べたい？",
  • "initId": "id:100",
  • "voiceText": "らーめん",
  • "clientData": {
    },
  • "appRecvTime": "2015-05-05 13:30:00",
  • "appSendTime": "2015-05-05 13:30:01"
}

Response samples

Content type
application/json
{
  • "systemText": {
    },
  • "talkend": false,
  • "emotionId": "happy",
  • "sound": {
    },
  • "timeout": 3,
  • "command": "Q09NTUFORCBURVNU",
  • "dialogStatus": { },
  • "serverSendTime": "2017-07-25 13:31:00"
}