シナリオ情報登録API

アクセス権限
特権 サーバ管理 テナント管理 シナリオ設計 AIML編集者

シナリオ情報を登録するAPIです。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/bots/{botId}/scenarios

リクエスト

Method POST
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
  Content-Type application/json;charset=UTF-8
Body JSON形式。(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード 成功

  • 201(Created)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 409(Conflict)
  • 429(Too many requests)
Body 成功:なし エラー:JSON形式

URLパラメータ

パラメータ名 説明
projectId シナリオ情報を登録するプロジェクトのIDを指定します。
botId シナリオ情報を登録するボットのIDを指定します。

リクエストパラメータ

キー
必須 説明
userScenarios object
配列
シナリオ情報を保持します。
   scenarioId string シナリオIDを設定します。最大100文字。
   description string シナリオの説明を設定します。最大100文字。(空文字列可)
   compileFlag boolean コンパイルフラグを設定します。
trueの場合はコンパイル対象になり、falseの場合はコンパイル対象になりません。

リクエスト例

レスポンスパラメータ

リクエストパラメータはありません。

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  パラメータなし なし
  パラメータ文字列長不正 なし
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
  プロジェクトID不正 なし
404(Not Found)
  ボットID不正 なし
409(Conflict)
  シナリオID重複(部分更新はない)
429(Too many requests)
  ロックアウト なし