GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Node (v2, BETA)
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Guardrails
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentiment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Guidelines
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Installing Botkit in AWS
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer

ADMINISTRATION
Intro to Bots Admin Console
Administration Dashboard
User Management
Managing Your Users
Managing Your Groups
Role Management
Manage Data Tables and Views
Bot Management
Enrollment
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Using Single Sign-On
Two-Factor Authentication for Platform Access
Security Settings
Cloud Connector
Analytics for Bots Admin
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Channel Enablement
  5. Adding the Web/Mobile Client Channel

Adding the Web/Mobile Client Channel

To use any Kore.ai Bot SDKs, you must first register your app to get the authentication credentials to communicate between the Kore.ai bot and your application hosting the bot. The Kore.ai bot SDKs can be used to add a chat widget to your company application that enables users to chat with the application using natural language input. The Kore.ai bots platform interprets the user input, processes the request, and responds to the user.

The bots Platform accepts requests only from authorized clients for connection and exchanging messages. To authorize the connection, you must register your app and get the required client credentials. The credentials authorize the client app and provide for user assertion.
This topic describes how to register your application and generate credentials for your clients that are required to exchange messages between your application and the Kore.ai bots Platform and then configure and add the Web/Mobile Client Channel to your bot.

To add the Web/Mobile Client Channel to your bot, you must first register or create an app in Bot Builder. When you create an app, you are provisioning credentials for your application to communicate securely with Kore.ai servers. After you create an app, you can use that app registration in the configuration to add the Web/Mobile Client Channel to your bot.

Add Web/Mobile Client Channel

The Web/Mobile Client channel can be configured using the following options:

Associate an App

  • When you choose to enable Web/Mobile client, an app is automatically created for you
  • You can choose to replace this app with any other app that you may want to use

To create your own app, follow these steps:

  1. Open the bot on which you want to add the Web/Mobile Client channel.
  2. On the bots menu, click Channel > Web/Mobile Client.
  3. In the Select App drop-down list, select your existing app registration or click Add App to create a new app.
  4. In the Name field, enter the name for the app registration used in Bot Builder. For example, weather app.
  5. Select one of these scopes for the app:
    • Allow anonymous users to chat with the bot: Enables anonymous users to interact with the bot.
    • Auto register new users on Kore.ai Bots Platform: Select to control the auto-user registration in Kore.ai if the user assertion is unknown.
  6. In the JWT Signing Algorithms Used For Client App Authentication drop-down list, select one of the following security algorithms:
    • RS256/RS512: Select to enable the Public Key. The Private key, used for encryption, is provided by the user, and the Public key, used for decryption, is provided by the Platform. Both the keys have to be used for generating the token. The Public Key is used by the XO Platform to authenticate the client application.
    • HS256/HS512: Select to generate a Secret Key and a Client ID. The Client ID is required for app initialization, and the Secret Key is used by the XO Platform to authenticate the client application.
  7. (Optional) In the Push Notifications section, click Enable and then specify a URL to send the notifications.
  8. When you Enable the Push Notifications, you can select one of the following options to manage the notifications:
    • All Messages – Sends push notifications for all conversation messages to the client app.
    • Message Delivery Failures – Sends push notifications for failure scenarios such as WebSocket Disconnected, App is Killed, and Message Delivery Failure.
  9. To customize the display messages for the push notifications messages sent to the client app, select one of the following options:
    • Send Original Messages – Sends the actual conversation message as part of the push notification.
    • Show a standard message from standard responses – Sends a generic message instead of the original message.
    • Click Manage Responses to add custom messages in the push notification. To learn more about adding responses, see Default Standard Responses and Default Conversations.
  10. Click Save and then Create. The app registration details appear.
  11. To copy the app registration details to the clipboard for your application, you can click Copy for Bot Name, Bot ID, and Client ID. For Client Secret, click View, and then click Copy.
  12. In the Allow Alert Task Setup section, select Yes to enable your application users to set up their own alert tasks using the web client. By default, this setting is disabled for web client users, but mobile client users can always setup their own alerts.
  13. In the Enable Channel section, select Yes to enable the channel immediately after saving.
  14. Click Save to save the settings and close the Web/Mobile Client Channel page.

The Channel Information updated successfully message is displayed on the top-right of the page.
Once enabled click here for steps to integrate your bot into your web application.

Choose Deployment Options

There are two different ways of deploying the Web/mobile client. You can either use the Kore.ai hosted Client or set up your own client and host it.

If you are using the Kore.ai hosted client, then there are two different approaches:

  • Share the URL with users
  • Embed code in your website

To choose deployment options, follow these steps:

  1. In the Web Client Details section, copy the URL to share this URL with users to interact with your virtual assistant.
  2. In the Embed Code section, copy the code to embed this Channel in your application pages where you want to display this virtual assistant widget.
  3. In the Whitelist Domains section, click +Add Domain to add URLs which want to include in the whitelist for your assistant.
  4. Click the Download SDK link to download, setup and configure the Web/Mobile SDK using the prebuilt SDK libraries.
  5. Select an appropriate option to Allow Alert Task setup. You can choose either Yes or No to let users to set up Alerts using Web Client.
  6. Click Save to save the settings and close the Web/Mobile Client Channel page.

Edit Web/Mobile Channel

To edit the Web/Mobile Client channel, follow the below steps:

  1. Hover over the channel to modify, and then click the Settings icon displayed to view the command menu, as shown in the screenshot below.
    Editing the Web/Mobile Client Channel
    Select one of the following commands to modify the channel:
  • Edit – Click to open the Web/Mobile Client channel setup page.
  • Disable/Enable – Click Disable to temporarily disable the use of the Web/Mobile Client channel for your bot. When the channel is disabled, click Enable to enable the use of the Web/Mobile Client channel.
  • Delete – Click Delete, and then click OK in the Delete Confirmation dialog to permanently delete the bot channel configuration.

Warning: This operation is permanent, and cannot be undone.

 

Adding the Web/Mobile Client Channel

To use any Kore.ai Bot SDKs, you must first register your app to get the authentication credentials to communicate between the Kore.ai bot and your application hosting the bot. The Kore.ai bot SDKs can be used to add a chat widget to your company application that enables users to chat with the application using natural language input. The Kore.ai bots platform interprets the user input, processes the request, and responds to the user.

The bots Platform accepts requests only from authorized clients for connection and exchanging messages. To authorize the connection, you must register your app and get the required client credentials. The credentials authorize the client app and provide for user assertion.
This topic describes how to register your application and generate credentials for your clients that are required to exchange messages between your application and the Kore.ai bots Platform and then configure and add the Web/Mobile Client Channel to your bot.

To add the Web/Mobile Client Channel to your bot, you must first register or create an app in Bot Builder. When you create an app, you are provisioning credentials for your application to communicate securely with Kore.ai servers. After you create an app, you can use that app registration in the configuration to add the Web/Mobile Client Channel to your bot.

Add Web/Mobile Client Channel

The Web/Mobile Client channel can be configured using the following options:

Associate an App

  • When you choose to enable Web/Mobile client, an app is automatically created for you
  • You can choose to replace this app with any other app that you may want to use

To create your own app, follow these steps:

  1. Open the bot on which you want to add the Web/Mobile Client channel.
  2. On the bots menu, click Channel > Web/Mobile Client.
  3. In the Select App drop-down list, select your existing app registration or click Add App to create a new app.
  4. In the Name field, enter the name for the app registration used in Bot Builder. For example, weather app.
  5. Select one of these scopes for the app:
    • Allow anonymous users to chat with the bot: Enables anonymous users to interact with the bot.
    • Auto register new users on Kore.ai Bots Platform: Select to control the auto-user registration in Kore.ai if the user assertion is unknown.
  6. In the JWT Signing Algorithms Used For Client App Authentication drop-down list, select one of the following security algorithms:
    • RS256/RS512: Select to enable the Public Key. The Private key, used for encryption, is provided by the user, and the Public key, used for decryption, is provided by the Platform. Both the keys have to be used for generating the token. The Public Key is used by the XO Platform to authenticate the client application.
    • HS256/HS512: Select to generate a Secret Key and a Client ID. The Client ID is required for app initialization, and the Secret Key is used by the XO Platform to authenticate the client application.
  7. (Optional) In the Push Notifications section, click Enable and then specify a URL to send the notifications.
  8. When you Enable the Push Notifications, you can select one of the following options to manage the notifications:
    • All Messages – Sends push notifications for all conversation messages to the client app.
    • Message Delivery Failures – Sends push notifications for failure scenarios such as WebSocket Disconnected, App is Killed, and Message Delivery Failure.
  9. To customize the display messages for the push notifications messages sent to the client app, select one of the following options:
    • Send Original Messages – Sends the actual conversation message as part of the push notification.
    • Show a standard message from standard responses – Sends a generic message instead of the original message.
    • Click Manage Responses to add custom messages in the push notification. To learn more about adding responses, see Default Standard Responses and Default Conversations.
  10. Click Save and then Create. The app registration details appear.
  11. To copy the app registration details to the clipboard for your application, you can click Copy for Bot Name, Bot ID, and Client ID. For Client Secret, click View, and then click Copy.
  12. In the Allow Alert Task Setup section, select Yes to enable your application users to set up their own alert tasks using the web client. By default, this setting is disabled for web client users, but mobile client users can always setup their own alerts.
  13. In the Enable Channel section, select Yes to enable the channel immediately after saving.
  14. Click Save to save the settings and close the Web/Mobile Client Channel page.

The Channel Information updated successfully message is displayed on the top-right of the page.
Once enabled click here for steps to integrate your bot into your web application.

Choose Deployment Options

There are two different ways of deploying the Web/mobile client. You can either use the Kore.ai hosted Client or set up your own client and host it.

If you are using the Kore.ai hosted client, then there are two different approaches:

  • Share the URL with users
  • Embed code in your website

To choose deployment options, follow these steps:

  1. In the Web Client Details section, copy the URL to share this URL with users to interact with your virtual assistant.
  2. In the Embed Code section, copy the code to embed this Channel in your application pages where you want to display this virtual assistant widget.
  3. In the Whitelist Domains section, click +Add Domain to add URLs which want to include in the whitelist for your assistant.
  4. Click the Download SDK link to download, setup and configure the Web/Mobile SDK using the prebuilt SDK libraries.
  5. Select an appropriate option to Allow Alert Task setup. You can choose either Yes or No to let users to set up Alerts using Web Client.
  6. Click Save to save the settings and close the Web/Mobile Client Channel page.

Edit Web/Mobile Channel

To edit the Web/Mobile Client channel, follow the below steps:

  1. Hover over the channel to modify, and then click the Settings icon displayed to view the command menu, as shown in the screenshot below.
    Editing the Web/Mobile Client Channel
    Select one of the following commands to modify the channel:
  • Edit – Click to open the Web/Mobile Client channel setup page.
  • Disable/Enable – Click Disable to temporarily disable the use of the Web/Mobile Client channel for your bot. When the channel is disabled, click Enable to enable the use of the Web/Mobile Client channel.
  • Delete – Click Delete, and then click OK in the Delete Confirmation dialog to permanently delete the bot channel configuration.

Warning: This operation is permanent, and cannot be undone.

 

Menu