進行中のボットの公開ステータス、または最後に完了したボットのステータスリクエストを取得します。 ボットAPIの公開の開始については、こちらをご参照ください。
このAPIを使用するには、アプリはボット公開の下にある 公開ステータスの管理者APIスコープを必要とします。
GEThttps://{{host}}/api/public/bot/{{BotID}}/publish/status
認証
ヘッダー内のJWTを含むAPIを、以下の構文で呼び出します。
auth: {{JWT}}
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| host | 環境URL、例：https://bots.kore.ai |
| BotID | ボットIDまたはストリームID。ボットの「一般設定」ページからアクセスできます。 |
応答コンテンツタイプ
application/json
サンプルのリクエスト
curl -X GET \
https://{{host}}/api/1.1/public/bot/{{BotID}}/publish/status/ \
-H 'Auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
サンプルのレスポンス
{
"_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
"jobType": "PUBLISH_BOT",
"streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
"__v": 0,
"action": "RUN",
"createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
"percentageComplete": 100,
"requestedTime": "2021-12-01T09:19:04.483Z",
"status": "successful",
"lastModifiedOn": "2021-12-01T09:19:05.808Z",
"initiatedOn": "2021-12-01T09:19:04.550Z",
"statusSummary": [
{
"resourceId": "SETTINGS",
"resourceType": "SETTINGS",
"name": "Settings",
"modules": [
"general",
"bot_variables",
"pii",
"ivr",
"hold_resume",
"custom_script",
"advanced"
],
"status": "SUCCESS"
},
{
"resourceId": "NL",
"resourceType": "NL",
"name": "Natural Language",
"modules": [
"nl_model",
"settings"
],
"status": "SUCCESS"
}
]
}
メモ：’status’フィールドの値は、「SUCCESSFUL」「FAILED」または「INPROGRESS」が可能です。