API Guide

Proactive Notifications allow enterprises to engage with their end users (customers or employees) by providing relevant and timely updates. Proactive notification includes: Nudge the employees to reset their password before it expires in certain days Remind users to submit expense reports. Inform customers about their order status. Other reminders which…

To fetch the status of Proactive Notifications API.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/notify/status/{{requestId}}   Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Proactive Messages Admin Console: Channel Management > Proactive Messages   Path Parameters Parameter Description Mandate host The environment URL.…

To fetch the publish status of the current bot or the last completed status request for the bot. To initiate the Publish API, refer here.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/publish/status Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin…

This API retrieves the list of individual billing sessions created for a bot so that you can review them for correctness and reconciliation. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/getBillingSessionsDetails For Bot Admin Console: https://{{host}}/api/public/getBillingSessionsDetails Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Billing Sessions…

To delete a specific execution of a Batch Test Suite.   Method DELETE Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin Console: Batch Tests Management   Query Parameters Parameter Description Mandate host The environment URL.…

To delete a Batch Test Suite.   Method DELETE Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin Console: Batch Tests Management   Query Parameters Parameter Description Mandate host The environment URL. For example, https://bots.kore.ai Required…

To import the test cases from a given Test Suite file.   Method POST Endpoint https://{host}/api/public/bot/{botId}/testsuite/import

To export the test cases of a given Batch Test Suite and get a link to download the file once the export is completed.   Method POST Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin…

To get the list of Batch Test Suites available for a bot.   Method GET Endpoint https://{host}/api/public/bot/{botId}/testsuite?skip={skip}&limit={limit} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin Console: Batch Tests Management   Path Parameters Parameter Description Mandate host The…

To get the status of the Batch Test Execution request against a unique ‘Request Id’ and provide the download link for the results file after the test execution is complete. Please refer to the Batch Test Execution API to learn more. Method GET Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId}/status Content Type application/json Authorization auth:…