Virtual Assistants

Get Dashboard Widget Data

To retrieve the data associated with custom widgets and the reports of a bot. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/dashboard/ {{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit=-1 Note: A POST API call is now supported to include the additional filters for querying the data. See Custom Dashboard Filters to know more about additional filters. Content Type application/json Authorization…

koreUtil Libraries

koreUtil libraries provide pre-written JavaScript functions which makes common or complex tasks easy to implement. These libraries often target specific tasks such as setting up recurring rules for calendar, parsing and manipulation of dates, conversion of dates between timezone, tools to simplify programming with strings, numbers, arrays, functions and objects…

Adding the Workplace by Facebook Channel

This channel enablement flow is modified as per the changes implemented by Facebook post v7.2 of the product. To add the Workplace by Facebook channel to your assistant, you need a developer portal Facebook account to configure the connection between Facebook Workplace and Kore.ai. Kore.ai application must be authorized to send…

Create Custom Dashboard

Let’s create a dashboard using various metrics to analyze the performance of a Virtual Assistant and identify trends for business needs using a Banking Bot as an example. Problem Statement As a Banking Bot client, you want to track the following metrics: Dollar Value Breakup Customer Type Summary Task Fulfillment…

Remove Users from Account

To remove users from an account. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method DELETE Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

Update User API

To update the user details. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method PUT Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

Create User API

To add users to an account. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method POST Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot…

Get User Information

To retrieve the user details. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method POST Endpoint https://{{host}}/api/public/usersInfo Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

Delete Customer Data Status API

Used to get the status of the Customer Data Delete request. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method GET Endpoint https://{{host}}/api/public/bot/eraseUsersData/status/:reqId Content Type application/json Authorization auth: {{JWT}} See How to generate…

Delete Customer Data API

This API is used to delete customer data. Note: Delete User will not proceed if the requested user is: An account owner or belongs to one or more accounts. The bot owner or co-developer for one or more bots. Method DELETE Endpoint https://{{host}}/api/public/bot/eraseUsersData Content Type application/json Authorization auth: {{JWT}} See…