API Guide

Language Updation API

To update for an existing language’s configuration for a virtual assistant.   Method PUT Endpoint https://{{host}}/api/version-Id/public/bot/botId/language Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management   Path Parameters Parameter Description Mandate host The…

Disable an Existing Language API

To disable an existing language for a virtual assistant.   Method POST Endpoint https://{{host}}/api/{{version-Id}}/public/bot/{{botId}}/language/status Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management   Path Parameters Parameter Description Mandate host The environment URL.…

Enable an Existing Language API

To enable an existing language for a virtual assistant.   Method POST Endpoint https://{{host}}/api/version-Id/public/bot/botId/language/status Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management   Path Parameters Parameter Description Mandate host The environment URL.…

Add and Enable a New Language API

To initiate the addition and enablement of a new language for a virtual assistant.   Method POST Endpoint https://{{host}}/api/version-Id/public/bot/botId/language Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management   Path Parameters Parameter Description…

Proactive Notifications API

To send proactive notifications to the configured channel for the bot.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/notify 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…

Proactive Notification Status API

To fetch the status of Proactive Notifications API.   Method POST 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. For…

Bot Publish Status – API

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…

Billing Sessions API

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…

Delete Batch Test Suite Execution API

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.…

Delete Batch Test Suite API

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…
Menu