API Guide

To get debug logs of a specific conversation (currently supported only for IVR Channel). Method GET Endpoint https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Debug Logs Admin Console: Not Applicable   Path Parameters Parameter Description host Environment URL, for…

To get complete information of all the users and their associated roles in the account. This API requires JWT generated by an application created only from the Bot Admin Console. Method GET Endpoint https://{{host}}/api/public/alluserroles? Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot…

To initiate a publish request for a bot. Note: Before calling the API, please ensure that atleast one channel is enabled for the bot.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/publish   Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin…

To get the status of the bot import request initiated using the Import Bot API for a new bot or an existing bot. Note: This API requires the JWT generated by an application created on the Bot Admin Console.   Method GET Endpoint https://{{host}}/api/public/bot/import/status/{{BotImportBIR}} Content Type application/json Authorization auth: {{JWT}}…

To import the bot definition file to an existing bot for a current version upgrade or previous version restoration. Note: This API requires the JWT generated by an application created on the Bot Admin Console.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/import Content Type application/json Authorization auth: {{JWT}} See How to generate…

To upload the botdefinition, botconfig, and botfunction files (if any) and the bot icon to the local server. Additionally, the API fetches the file ID to be used in Import Bot API. Note: You need to upload the files separately. You can upload a file by signing with any app…

To create a new bot in the account owner’s Builder Tool using the File IDs generated when uploading the files to the local server. Please refer to the Upload File API for uploading and obtaining the File Id.   Note: The API requires the JWT generated by an application created…

Gets the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Refer here for initiating Bot Export API.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/export/status Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

To export the bot definition and all the associated components. Note: This API only initiates the export process. Please use the Export Status API to view the export progress status and obtain a link to download the file once the export completes. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/export Content Type application/json Authorization…

To export the ML utterances of a bot by creating a request ID to generate the download link of the bot using the ML Utterance Export Status API.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlexport Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…