{"id":31993,"date":"2021-12-06T12:01:38","date_gmt":"2021-12-06T12:01:38","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-1\/?p=31993"},"modified":"2021-12-06T12:01:38","modified_gmt":"2021-12-06T12:01:38","slug":"bot-publish-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-1\/docs\/bots\/api-guide\/bot-publish-status-api\/","title":{"rendered":"Bot Publish Status – API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Gets the publish status of the ongoing bot or the last completed status request of the bot. Refer here for initiating Publish Bot API<\/a>.<\/span><\/p>\n

To use this API, app needs the Admin API Scope of Publish Status<\/em> under Bot Publish<\/em>.<\/p>\n

GET<\/b>https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/publish\/status<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/span><\/td>\nEnvironment URL, for example,https:\/\/bots.kore.ai<\/code><\/span><\/td>\n<\/tr>\n
BotID<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response content type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X GET \\\r\n  https:\/\/{{host}}\/api\/1.1\/public\/bot\/{{BotID}}\/publish\/status\/ \\\r\n  -H 'Auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"_id\": \"ber-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"jobType\": \"PUBLISH_BOT\",\r\n    \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"__v\": 0,\r\n    \"action\": \"RUN\",\r\n    \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"percentageComplete\": 100,\r\n    \"requestedTime\": \"2021-12-01T09:19:04.483Z\",\r\n    \"status\": \"successful\",      \r\n    \"lastModifiedOn\": \"2021-12-01T09:19:05.808Z\",\r\n    \"initiatedOn\": \"2021-12-01T09:19:04.550Z\",\r\n    \"statusSummary\": [\r\n       {\r\n         \"resourceId\": \"SETTINGS\",\r\n         \"resourceType\": \"SETTINGS\",\r\n         \"name\": \"Settings\",\r\n         \"modules\": [\r\n             \"general\",\r\n             \"bot_variables\",\r\n             \"pii\",\r\n             \"ivr\",\r\n             \"hold_resume\",\r\n             \"custom_script\",\r\n             \"advanced\"\r\n           ],\r\n      \"status\": \"SUCCESS\"\r\n    },\r\n    {\r\n      \"resourceId\": \"NL\",\r\n      \"resourceType\": \"NL\",\r\n      \"name\": \"Natural Language\",\r\n      \"modules\": [\r\n           \"nl_model\",\r\n           \"settings\"\r\n           ],\r\n        \"status\": \"SUCCESS\"\r\n    }\r\n  ]\r\n}\r\n<\/pre>\n
Note<\/strong>: The possible values for the ‘status’ field are – SUCCESSFUL, FAILED or INPROGRESS.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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:...","protected":false},"author":17,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-31993","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts\/31993","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/users\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/comments?post=31993"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts\/31993\/revisions"}],"predecessor-version":[{"id":31994,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts\/31993\/revisions\/31994"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/media?parent=31993"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/categories?post=31993"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/tags?post=31993"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}