API Guide

To send proactive notifications to the configured channel in bot. To use this API, the app needs the Bot Builder API scope of Proactive Messages OR the Admin API Scope of Proactive Messages and respective channel should be configured and published with proactive notifications option enabled in the bot. POST…

To fetch the status of Proactive Notifications API. To use this API, the app needs the Bot Builder API scope of Proactive Messages OR the Admin API Scope of Proactive Messages. POST https://{{host}}/api/public/bot/{{BotID}}/notify/status/{{requestId}}. Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

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…

This API retrieves the list of individual billing sessions created for a bot so that you can review them for correctness and reconciliation. . This API is available in BT and BAC app scopes. To use this API, an app needs the Bot Builder API scope of Billing Sessions. OR…

Used to delete a specific execution of a Batch Test Suite. To use this API, the app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. DELETE https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai botID Bot ID.…

Used to delete a Batch Test Suite. To use this API, the app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. DELETE https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai botID Bot ID or Stream ID. You…

To import the test cases from a given Test Suite file. To use this API, app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. POST https://{host}/api/public/bot/{botId}/testsuite/import Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or…

To export the test cases of a given Batch Test Suite and get a link to download the file once the export is completed. To use this API, the app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. POST https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export…

To get the list of Batch Test Suites available for a bot. To use this API, app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. GET https://{host}/api/public/bot/{botId}/testsuite?skip={skip}&limit={limit} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID…

Gets the status of Batch Test Execution request against a unique ‘Request Id’ and provides the download link for the results file after the test execution is complete. Refer here for initiating Batch Test Execution API. To use this API, the app needs the Bot Builder Scope of Batch Tests Execution.…