ボットの情報を取得するAPIです。
エンドポイント
URL
https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/bots/{botId} |
リクエスト
Method | GET |
|
---|---|---|
Header | Authorization |
ログインAPIで払い出したアクセストークンを指定します。 |
Body | なし |
レスポンス
ステータスコード | 成功
エラー
|
---|---|
Body | 成功:JSON 形式 エラー:なし |
URLパラメータ
パラメータ名 | 説明 |
---|---|
projectId |
取得する対象のボットが存在するプロジェクトIDを指定します。 |
botId |
取得する対象のボットIDを指定します。 |
リクエストパラメータ
リクエストパラメータはありません。
レスポンスパラメータ
ログインしたユーザの権限によって、返却されるキーが異なります。権限については説明欄をご覧ください。
キー |
型 | 必須 | 説明 | |
---|---|---|---|---|
bots |
object 配列 |
– | ボット毎に情報を保持します。 | |
botId |
string |
– | ボットIDが設定されます。 | |
scenarioProjectId |
string |
– | サーバ管理者によって予め登録された転送先ホストの識別子を設定します。 設定する値についてはサーバ管理者にお問い合わせください。 また、SUNABAにおいては "DSU" を固定で設定してください。 |
|
language |
string |
– | ja-JP やen-US などシステムでサポートされている言語が設定されます。 |
|
description |
string |
– | ボットの説明文が設定されます。 | |
sraix |
string |
– | テナント管理者以上 <sraix>による呼び出しが設定されます。 |
レスポンス例(正常)
1 2 3 4 5 6 7 8 9 10 11 |
{ "bots": [ { "botId": "ボットID", "scenarioProjectId", "シナリオプロジェクトID", "language": "ja-JP", "description": "テスト用のボットです。", "sraix" : "global"|"public"|"project"|"null" } ] } |
レスポンス例(エラー)
HTTPステータス/原因 | レスポンス内容 | |
---|---|---|
401 (Unauthorized) |
||
トークン不正 | なし | |
パスワードが期限切れもしくは旧式や初期パスワード | なし | |
403 (Forbidden) |
||
アクセス権不正 | なし | |
プロジェクトID不正 | なし | |
404 (Not Found) |
||
ボットID不正 | なし | |
429 (Too many requests) |
||
ロックアウト | なし |