Gets the publish status of the ongoing bot or the last completed status request of the bot. Refer here for initiating Publish Bot API.
To use this API, app needs the Admin API Scope of Publish Status under Bot Publish.
GEThttps://{{host}}/api/public/bot/{{BotID}}/publish/status
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Query Parameters
| Parameter | Description |
|---|---|
| host | Environment URL, for example,https://bots.kore.ai |
| BotID | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
Response content type
application/json
Sample Request
curl -X GET \
https://{{host}}/api/1.1/public/bot/{{BotID}}/publish/status/ \
-H 'Auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Sample Response
{
"_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"
}
]
}
Note: The possible values for the ‘status’ field are – SUCCESSFUL, FAILED or INPROGRESS.