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

Steps to create your own app:

1. Open the bot on which you want to add the Web/Mobile Client channel.

2. On the bots menu, click Channels & Flows > Channels > Digital > All > 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 set up 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

Here are the available deployment options.

• Shareable URL: Use this to share the bot with internal stakeholders for validation. It opens a chat widget on a Kore-hosted webpage, which isn’t intended for end-users.
• Embed Script: Add the chat widget to your website with basic customizations like theme changes. Advanced customizations aren’t supported, and all users will appear as anonymous.
• Web SDK: Provides full control for integrating the chat widget into your website.

Steps to choose deployment options:

1. In the Web Client Details section, copy the URL and share it with internal stakeholders for validation and interaction 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

Steps to edit the Web/Mobile Client channel:

1. You can edit, test, disable or delete the channel. Learn more

2. Select one of the following commands to modify the channel:

3. Edit – Click to open the Web/Mobile Client channel setup page.

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

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

Virtual Assistant Theme & Design

The Theme and Design feature allows platform users to easily customize various aspects of VA interfaces, such as welcome text, buttons, colors, chat windows, and sound themes. This helps create engaging and user-friendly bot experiences aligned with specific design requirements. A real-time preview pane shows changes before deployment for quick adjustments. While the default light and dark themes cannot be edited, users can create a new themes using the templates themes. The light theme is used by default.

Steps to change the theme and design:

1. Navigate to Flows & Channels > Channels > Digital > Configured.

2. Click Web/Mobile Client.

3. On the Configure tab, click Edit to change the current theme.
   

4. The theme editor page displays all the templates and created themes, if any.

   Note

   You cannot edit the templates, but you can create a custom theme using a template.

5. Click + New Theme. The theme store page is displayed.

6. Select the theme and click Get Theme.

7. On the theme editor page, make the required changes in the Components and the Chat Screen sections. The changes are reflected in the preview pane.
   

8. Click Save. The custom theme is created.

9. Select the theme and click Apply.

10. To push the modification from the development to the published state, publish the VA.