ボット更新API

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

ボットの更新を行うAPIです。

エンドポイント

URL

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

リクエスト

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

レスポンス

ステータスコード 成功

  • 204(No Content)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 429(Too many requests)
Body なし

URLパラメータ

パラメータ名 説明
projectId 更新対象のボットが存在するプロジェクトIDを指定します。
botId 更新対象のボットIDを指定します。

リクエストパラメータ

ログインしたユーザの権限によって、設定可能なキーが異なります。権限については説明欄をご覧ください。

キー
必須 説明
scenarioProjectId string サーバ管理者によって予め登録された転送先ホストの識別子を設定します。
設定する値についてはサーバ管理者にお問い合わせください。
また、SUNABAにおいては"DSU"を固定で設定してください。
language string ja-JPen-USなどシステムでサポートされている言語を設定します。
description string 更新するボットの説明文を最大100文字で設定します。
sraix string テナント管理者以上 <sraix>による呼び出しを以下のいずれかから指定します。
globalpublicproject、または無効とするnull

レスポンスパラメータ

レスポンスパラメータはありません。

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  パラメータ不正 なし
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
404(Not Found)
  ボットID不正 なし
429(Too many requests)
  ロックアウト なし