API Guide

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…

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

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

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…

To fetch the feedback survey scores provided by the user in the conversation with a virtual assistant and push the data for visualization on the Feedback Analytics module using the Survey Type and Survey Name.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/saveFeedback   Content Type application/json Authorization auth: {{JWT}} See How to…

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

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

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