Setting up the Kore.ai Virtual Assistant connector app
The Kore.ai Virtual Assistant app in the Zoom App Marketplace allows you to integrate the Kore.ai XO Platform with Zoom Contact Center. Businesses can quickly add self-service, automation and conversational assistance for end customer. For more information on how this integration works, see the Kore.ai / Zoom Contact Center channel support article.
Prerequisites for using the Kore.ai Virtual Assistant connector app
Important: Zoom does not provide technical support for the Kore.ai XO Platform. If you need help, contact Kore.ai or your IT admin that manages the application.
How to access the Kore.ai Virtual Assistant connector app
You can access custom connector apps from two different places: the Zoom App Marketplace listing page, or the Manage Connectors page.
Accessing the app from the Zoom App Marketplace
- Sign in to the Zoom App Marketplace using admin credentials.
- Use the search box to find the Kore.ai Virtual Assistant app.
- Click on the app's icon or name to access it.
- Click Create Connector.
Accessing the app from the Manage Connectors page
- Sign in to the Zoom App Marketplace using admin credentials.
- In the top-right corner, click Manage.
- In the Admin App Management section, click Manage Connectors.
- Click Add Connector then Koreai.
How to set up the Kore.ai Virtual Assistant connector app
To set up Zoom Contact Center as a channel, the bot has to be associated with the instance of the Kore.ai Chat bot connector available in the Zoom app marketplace.
Build a chatbot
- Follow the previous section to access the Custom Connector app.
- Enter the following information. Both fields are required:
- Connector Name: Provide a unique and descriptive name for your connector. This will help you identify the connector easily when managing multiple connections.
- Connector Description (optional): Enter a description for your connector.
- Choose Bot Type: Select Chatbot.
- Click Next.
- Enter the Kore.ai API authorization information:
- Choose Region: Select the region you want the chatbot to be available from.
- Base URL: Displays the base URL, for example, bots.kore.ai. The base URL field will show the corresponding value depending on selected region.
- Authorization Parameters
- Bot ID, Client ID, Client Secret: This will be taken from the Kore.ai platform. Paste these values from the Channels Configuration section of your Kore.ai XO Platform admin portal.
- Click Next.
- Copy the Post URL and Access Token.
- Paste these values to the relevant fields to the Kore.ai XO Platform admin portal in the Zoom Contact Center Configurations section. Copy the Webhook URL.
- In the Kore.ai Chatbot Connect page, paste the Webhook URL you obtained from Kore.ai XO Platform admin portal.
- In the Kore.ai XO Platform admin portal - Zoom Contact Center Configurations section, select Yes under Enable Channel. Click Save. Click Deploy Publish tab, then follow the on-screen instructions to publish the connector.
- Click Next to authorize the Kore.ai Chatbot connector with the Kore.ai platform.
Build a voicebot using the Smart Assist platform
Create a Kore.ai voicebot
- Log into Kore.ai SmartAssist platform.
- Log into Kore.ai BotBuilder platform.
A default instance bot will be created in bot builder portal for the first time. This is the parent bot.
Enable chat history and summary
- Log into Kore.ai BotBuilder platform.
- Click on the instance bot.
- In the left navigation, click Channels.
- Click Web/Mobile Client, then configure the Web/Mobile Client settings.
- Click Save.
- In the left navigation, select APIs & Extensions, then API Scopes.
- In the top-right corner, click the New button.
- From the App drop-down, select the instance bot.
- Under Scopes, select Chat History and Conversation Summary.
- Click Save.
- Above the left navigation menu, click the Build tab, then select Natural Language.
- Select Generative AI & LLM, then click the down arrow
next to LLM Integrations to enable Kore.ai XO GPT. - Once enabled, click the down arrow
next to Co-Pilot, and toggle Conversation Summary on. - Click the Select Model down arrow
, then select Kore.ai XO GPT. - Above the left navigation menu, click the Deploy tab and publish the bot by clicking the Proceed button.
Create a flow
- Log into Kore.ai SmartAssist platform.
- Click the Configuration tab.
- In the top-left corner, click New Flow.
- Enter a display name and description for your flow.
- From the Flow Type dropdown, select Inbound Flow, and configure all other details.
- Click Create and Continue to Flow Design.
- Click the Automations tab.
- Click Add Bot, then Attach a bot from library.
- Choose from the list of available flows.
The selected flow will be imported into the flow design canvas. - (Optional) Click Test Flow to check if the flow is working.
- At the top-right, click Publish.
Create a Kore.ai voicebot connector in Zoom's Marketplace and define SIP Transfer channel in Kore.ai
- Sign in to the Zoom App Marketplace using admin credentials.
- Use the search box to find the Kore.ai Virtual Assistant app.
- Click Create Connector.
- Specify the Connector Name, Description and select Voicebot as the Bot Type.
- Click Next.
- Paste the Bot ID, Client ID, and Client Secret. Authorization parameters can be obtained from one of the following methods:
- Click the Configurations tab, then Channels. Click Chat then Web/Mobile Client. In the App Details, copy the Bot ID, Client ID, and Client Secret.
- Click the instance bot, then Deploy. In the Channels tab, click Web/Mobile Client. In the App Details, copy the Bot ID, Client ID, and Client Secret.
- Click the instance bot, then Deploy. In the left navigation, select APIs & Extensions, then API Scopes. Edit the instance bot, then copy the Bot ID, Client ID, and Client Secret from the Edit App Definition panel.
- Click Next.
- Copy the Domain Name and DID number.
- Return to the SmartAssist platform.
- Click the Configurations tab, then Channels.
- Click SIP Transfer, then New.
- Click Configure SIP Transfer and paste the Domain Name and DID number from Zoom's Marketplace.
- Select the Domain Name option in the Network section, then select SRV for DNS Resolve Method.
- Select TLS for SIP Transport Type, then check the Pad Crypto checkbox.
- Click Next.
- Select Inbound Calls and Outbound Calls, then click Save.
- Click Attach Flow and assign the desired flow created in the previous section.
- In the left navigation, click the Deploy tab and publish the bot by clicking the Proceed button.
Define the agent transfer settings for Kore.ai voicebot
- Log into Kore.ai SmartAssist platform.
- Click the Configuration tab.
- in the left navigation, click Agent Transfer.
- Under Outgoing Voice Agent Transfer, click SIP Transfer.
- From the SIP Transfer Method dropdown, select SIP BYE.
- Click Save.
Create a Zoom Contact Center flow and select Kore.ai bot connector
- Sign in to the Zoom web portal.
- In the left navigation, click Contact Center Management, then Flows.
- Click Add Flow.
- In the flow canvas, add a Bot widget and select your Kore.ai voicebot connector from the bot list.
- Define your flow and specifying bot exits:
- Transfer To: For agent escalations, usually routed to a queue.
- End: For cases when the voicebot successfully handles the engagement without needing an agent.
- Timeout: For cases when the system cannot connect to the Kore.ai platform; this can also be routed to the queue.
- Save and Publish the flow.
Note: For the Start widget, define entry point by selecting a phone number.
Build a voicebot using the XO platform
Create a Kore.ai voicebot
- Log into Kore.ai XO platform.
- Click the New App button, then select New App.
- In the Automation AI tile, click Create New.
- Select either Express or Custom Setup, then click Next.
- Follow the instructions to add app name, FAQ, Generative AI link, and Agent Transfer use cases.
- (Optional) Test the newly-created bot.
Create JWT app and define API scope for Kore.ai voicebot
- Log into Kore.ai XO platform.
- In the left navigation, click the App Settings icon, then select Dev Tools.
- Click the API Scopes tab and click the New Mapping button.
- In the JWT App dropdown, select the Create JWT App option.
- Enter the app name (for example, My Bot JWT App) and select HS256 as the JWT Signing Algorithm.
- Click Next, then Done.
- Scroll down to the Automation tab and click the Chat History and Conversation Summary toggles.
- Click Save.
- In the left navigation, click the Deploy tab and publish the bot by clicking entering a comment, and clicking the Proceed button.
Create Kore.ai voicebot connector in Zoom's Marketplace and define SIP Transfer channel in Kore.ai
- Sign in to the Zoom App Marketplace using admin credentials.
- Use the search box to find the Kore.ai Virtual Assistant app.
- Click Create Connector.
- Specify the Connector Name, Description and select Voicebot as the Bot Type.
- Click Next.
- Paste the Bot ID, Client ID, and Client Secret from the JWT App created in step 2. This information can be found by navigating to Flows & Channels > Digital > Web/Mobile Client, then selecting JWT App Details.
- Click Next.
- Copy the Domain Name and DID number. Do not click Next yet.
- Return to the XO platform.
- In the left navigation, click Flows & Channels, then select Kore.ai Voice Gateway.
- Click the SIP Numbers tab.
- Click Configure SIP Transfer and paste the Domain Name and DID number from Kore.ai Voicebot Connector page.
- Select the Domain Name option in the Network section, then select SRV for DNS Resolve Method.
- Select TLS for SIP Transport Type, then check the Pad Crypto checkbox.
- Click Next.
- Select Inbound Calls and Outbound Calls, then click Save.
- Click Attach Flow and associate your bot's Welcome Voice Flow with this SIP Transfer channel. Ensure that Agent Transfer is already set up.
- In the left navigation, click the Deploy tab and publish the bot by clicking the Proceed button.
- Go back to the Zoom's Marketplace Domain Name and DID number configuration page from step 12 and click Next.
Define Agent Transfer settings for Kore.ai voicebot
- Log into Kore.ai XO platform.
- In the left navigation, click the App Settings, then Integrations.
- Click the Agent Transfer tab, then select Voice.
- Click SIP Transfer (Default).
- In the left panel that opens, click the Configuration tab.
- Under SIP Transfer Method, select SIP BYE, click Save, then OK.
- In the left navigation, click the Deploy icon and publish the bot by clicking the Proceed button.
Enable Kore.ai Conversation Summary GenAI model
- Log into Kore.ai XO platform.
- In the Go Models Library, click on the three dots, select Model, and then enable the fine-tuned model for Summarizing Conversations.
- In the left navigation, click the Generative AI Tools icon, then select GenAI Features.
- In the Co-Pilot tab, click the Conversation Summary toggle and select Kore.ai XP GPT - Summarizing Conversations under the Model column.
- In the left navigation, click the Deploy tab and publish the bot by clicking the Proceed button.
Create a Zoom Contact Center Flow and select your Kore.ai bot connector
- Sign in to the Zoom web portal.
- In the left navigation, click Contact Center Management, then Flows.
- Click Add Flow.
- In the flow canvas, add a Bot widget and select your Kore.ai voicebot connector from the bot list.
- Define your flow and specifying bot exits:
- Transfer To: For agent escalations, usually routed to a queue.
- End: For cases when the voicebot successfully handles the engagement without needing an agent.
- Timeout: For cases when the system cannot connect to the Kore.ai platform; this can also be routed to the queue.
- Save and Publish the flow.
The following table lists the supported data formats for the Kore.ai integration. Click the embedded links to learn more about each format.