API Guide

To fetch the conversational details and conversation summary data between the bot and the user. This API supports pagination. You can specify skip and limit parameters to retrieve a certain number of messages at a time. Method POST Endpoint https://{{host}}/api/public/bot/{{botId}}/conversationDetails Content Type application/json Authorization auth: {{JWT}} API Scope Bot Builder:…

The API summarizes the conversation between a user and an agent. The agent can be a virtual agent or a human agent. The API accepts the conversation Id or the transcripts as input and provides an auto-generated conversation summary. The API uses a fine-tuned Flan-T5 model, an open-source LLM hosted…

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…

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…

To initiate the addition and enablement of a new language for a virtual assistant. Method POST Endpoint https://{{host}}/api/1.1/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 Required Description host…

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…