API Guide

Used to get the status of the Customer Data Delete request. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Delete Users Data under Bot Analytics. GET https://{{host}}/api/public/bot/eraseUsersData/status/:reqId NOTE: This feature was introduced in ver7.1…

Used to delete customer data. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Delete Users Data under Bot Analytics. DELETE https://{{host}}/api/public/bot/eraseUsersData NOTE: This feature was introduced in ver7.1 of the platform. Delete User will…

Postman is a popular tool to help test and develop APIs. To make it more convenient for integration with the Kore.ai APIs, we’ve developed a Postman collection. The entire collection is divided into two categories: APIs which are related to the Bot Builder functionality; APIs related to the Admin Console…

This API retrieves the conversation sessions created. The API details are available in the Bot Builder and Bot Admin Console (BAC) app scopes. To use this API, app needs the Bot Builder API scope of Bot sessions.OR the Admin API Scope of Bot sessions under Bot Analytics. POST https://{{host}}/api/public/bot/{{BotID}}/getSessions?containmentType={{containmentType}}and https://{{host}}/api/public/getSessions?containmentType={{containmentType}} for…

Fetches the conversational messages between the bot and user in reverse chronological order. This API supports pagination. You can provide offset/skip and limit to get a certain number of messages at a time. This is a newer version of the old API which will soon be deprecated. This revised API…

Following is the list of APIs available from the Kore.ai Bots Platform. For details on the API functioning and usage instructions refer here. These APIs are available for testing in your Postman setup, for configuration details see here. Based on the functionality addressed, the APIs can be categorized as: APIs…

To get debug logs of a specific conversation (currently supported only for IVR Channel). To use this API, app needs the Bot Builder API scope of Debug Logs. GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai version Refers to the version of the API. The current…

To get full information of all users and their associated roles in the account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role Management. GET https://{{host}}/api/public/alluserroles? Query Parameters Parameter Description…

Used to initiate a publish request for a bot. Before calling the Publish Bot API, make sure that at least one channel is enabled for the bot. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API…

Used to get the status of the bot import request initiated using Import Bot as New Bot API or Import Bot into an Existing Bot API. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope…