API Guide

To fetch the status of a proactive notification triggered via the async webhook channel.  Method GET Endpoint {{host}}/api/public/bot/{{streamId}}/notifyV2/status/{{dockstatusId}} 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…

The Proactive Notifications API V2 enables sending various types of messages to users via IVR and Hangout channels.  Proactive notification includes: Nudge the employees to reset their passwords before it expires in a certain days Remind users to submit expense reports. Inform customers about their order status. Other reminders that…

This API allows you to update the default language for a bot using the botId. Method POST Endpoint https://{{host}}/api/1.1/public/bot/{{botId}}/defaultLanguage 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…

To execute and get results for managing an account’s SSO configurations with the following APIs: Fetch the SSO Meta API Enable SSO API Disable SSO API Update the SSO Configuration API Note: The APIs support SAML, WSFED, and OpenID Connect protocols. Fetch the SSO Meta API If SSO is enabled,…

For managing the SDK push notifications, the platform provides the following APIs: Device Subscription API Subscribed User Devices API Device Unsubscription API Note: To receive push notifications, each user’s device must be registered and subscribed via the mobile or WebSDK app. Device Subscription API This API manages SDK push message…

This API provides a summary of the billing usage specific to an account or bot for a given period. Method POST and GET Endpoint POST For Bot Builder: https://{{host}}/api/public/bot/{{BotID}}/billingsessionsummary For BAC: https://{{host}}/api/public/billingsessionsummary Important: First, use the POST method to set filters, then use the following GET method to retrieve the…

This task-wise Containment Report offers a comparative analysis of the impact of task executions on overall containment. It breaks down task-wise successes and failures by containment type, including Drop-off, Self-service, and Agent Hand-off, providing a detailed overview for better understanding and decision-making. Method POST and GET Endpoint It’s a combination…

This API lets you get the LLM & Generative AI Usage Logs for both Co-Pilot and Dynamic Conversation features. Method POST End Point https://{{host}}/api/1.1/public/bot/{{botId}}/getLLMUsageLogs Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Fetch Gen AI and LLM Usage Logs Admin Console:…

The Platform enforces rolling rate limits to restrict the number of API requests a user, application, or service can make within a dynamic timeframe. It helps prevent a single user or service from consuming disproportionate resources that could degrade the service for others. Requests are monitored against both 60-second and…

This API allows you to import bot functions from a specified file. Method POST Endpoint https://{{host}}/api/public/bot/botId/import/botfunctions Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Bot Definition > Bot Import Query Parameters Parameter Required Description host Required The…