Skip to content

Genesys Voice

This document provides detailed instructions on the manual integration process of the Kore.ai Agent AI widget into a Genesys Cloud CX environment when using an XO 11 App. It offers step-by-step guidance to ensure a smooth and efficient setup process, covering all necessary aspects of integration from start to finish.

Prerequisites

  • Genesys Cloud account with sufficient admin rights.
  • Kore.ai XO 11 Instance with at least one Dialog Task configured for Agent AI (https://platform.kore.ai).

Manual Steps

After setting up the Genesys Cloud account, you must have proper permission to use the following Genesys components:

  • OAuth Credentials
  • Interaction Widget (Integration)
  • Audiohook (Integration) – optional, if using Kore-managed Transcriptions.
  • Data Table

Step 1: OAuth Credential

An OAuth credential with proper permissions is required for the connection between the Kore.ai Agent AI interaction widget and the Kore.ai platform.

A Genesys OAuth ID is required to complete the URL formation for the Genesys interaction widget.

Steps to get Genesys OAuth ID:

  1. Sign in to Genesys Cloud.
  2. Go to Admin > Integrations > OAuth.
    genesys-oauth-path
  3. Click Add Client.
    integ-oauth-add-client
  4. Enter the app name, description, and token duration in the App Name, Description, and Token Duration fields.
  5. Select Token Implicit Grant (Browser) in the Grant Types fields.
  6. Add https://platform.kore.ai/koreaiaa-genesys/ in the Authorized redirect URIs (one per line) section.
  7. Add the following list of scopes in the Scope section:
    • architect
    • conversations
    • conversations:readonly
    • integrations
    • integrations:readonly
    • messaging
    • messaging-platform
    • messaging-platform:readonly
    • messaging:readonly
    • notifications
    • user-basic-info
    • web-chat
    • web-chat:readonly

oauth-client-details

oauth-client-details-second-image

After saving the configuration, you will get the Client Id of the created OAuth client. Copy the ID and have it available for Step 2.

Step 2: Interaction Widget

Create a new Interaction Widget. This widget is hosted in the Genesys agent desktop and provides the Agent AI solution features to agents.

  1. Sign in to Genesys Cloud.
  2. Click Admin > Integrations.
    genesys-admin-integ-path
  3. If you have not created an Interaction Widget for Agent AI, install a new Interaction Widget by clicking the Integrations tab on the right side of the page. new-interaction-widget
  4. Name the Interaction Widget with a meaningful name, such as KoreaiAA Interaction Widget.
  5. Open the Interaction Widget by clicking the name. open-interaction-widget
  6. Go to the Configuration tab of the Interaction Widget. interaction-widget-configuration-tab
  7. In the Application URL field, enter the following structure; use the OAuth ID from Step 1: https://platform.kore.ai/koreaiaa-genesys/?conversationid={{gcConversationId}}&lang={{gcLangTag}}&environment={{gcHostOrigin}}&genesysid=<genesys-oauth-Id>
  8. Allow all permissions in iFrame Sandbox Options and iFrame Feature/Permission Policy.

iFrame Sandbox Options: allow-forms,allow-modals,allow-popups,allow-presentation,allow-same-origin,allow-scripts,allow-downloads.

iFrame Feature/Permission Policy: camera,microphone,geolocation,clipboard-write,display-capture,fullscreen.

Communication Type Filtering: chat, call, callback, email, sms, line, facebook, instagram, twitter, open, webmessaging, whatsapp.

Step 3: Agent Access

To view the Interaction Widget, agents must have the following accesses:

Group Membership

An Interaction Widget uses Group Membership to determine who can view it on the agent desktop.

  1. Use an existing Group, if your agents are already part of it. Otherwise, create a new Group for Agent AI permission.
  2. Name the Group as KoreAA-Agents or similar to distinguish it.
  3. Add any agent to allow them to use the Agent AI functionality. You can utilize more than one Group, if required.
  4. Go back to the Integrations section and open the Interaction Widget created in Step 2.
  5. On the Configuration tab, add access using the Group you identified or created for Agent AI in the Group Filtering option.

You may also utilize Queue Filtering (optional).
configuration-group-filtering-9

Custom Role/Permission

By default, most agents don’t have access to read from a Data Table. You must grant them explicit permission to read from the Data Table for loading the Interaction Widget.

  1. Sign in to Genesys Cloud.
  2. Go to Admin > People & Permissions > Roles / Permissions.
  3. Click Add Role to create a new Role.
  4. Give a distinctive name to the Role; for example, KoreaiAA Agent.
  5. On the Permission tab, search for the following and add (select the box):

    Architect > DataTable > View

    Conversation > Transcription > View

    Note

    The Conversation permission is available only in CX3 license.

  6. Once finished, the Assigned Permissions view should look like this: assigned-permissions

  7. Once the role is created, click the three dots at the right end of the Permission role and select Change Membership. change-membership
  8. Add appropriate agents to the role.

Step 4: Data Table Configuration

This step includes creation of a Data Table with Agent AI bot details.

Note

The configuration data is stored directly in the Custom Fields of the Data Table, not in a Data Table row. A single Data Table represents a configuration of Agent AI. In other words, the default values of the Custom Fields contain the necessary configuration data to load the Agent AI widget.

  1. Sign in to Genesys Cloud.
  2. Go to Admin > Architect > Data Tables.
    genesys-architect-data-tables
  3. Create a new Data Table by clicking the plus icon, and provide a relevant name such as KoreaiAA-configuration. new-data-table
  4. Click the “three dots,” and select Edit Table Fields from the list. edit-table-fields

    Note

    Reference Key label must be set to “agentAssist”. This is the value used by the Interaction Widget to load the configuration data.

  5. Click Add Field to create five custom fields to provide the Agent AI configuration. add-field-15

  6. Click the Add Field button under Custom Fields. Set the data type for all custom fields as String while adding.
    custom-field-string
  7. Add the custom fields with Bot details.
    custom-field-bot-details
  8. Follow the below conventions for other custom fields. Use the exact names, including upper/lower case.

These values are found in the Flow & Channels > Channels > Digital > Configured Channels > JWT App Details section of the XO application.

Field Label Default Value
AgentAssist URL https://platform.kore.ai/koreagentassist-sdk-v3/UI/agentassist-iframe.html
Bot Id st-8cb94691-xxxx-xxxx-xxxx-xxxxxxxx
Client Id cs-b60f544d-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Client Secret <secret-key from Agent AI>
is Audiohook Enabled true / false

Note

  • All the custom fields should be of the string type.
  • If the “is Audiohook Enabled” option is false, the application tries to utilize the Genesys native transcriptions using the Transcriptions API.

To change the values, you must click the gray box surrounding each Custom Field, not directly on the textbox.

Step 5 (Optional): Audiohook Integration

The final step is to install Audiohook for voice streaming, if using Kore-managed Transcriptions.

  1. Sign in to Genesys Cloud.
  2. Go to Admin > Integrations > Integrations.
    genesys-admin-integrations The Audiohook integration requires specific configuration values to support Agent AI configuration.

  3. Install a new audiohook app by clicking the Integrations button on the top-right corner.
    add-new-audiohook

    locate-audiohook

  4. Open the audiohook, and go to the Configuration tab.
    audiohook-configuration-tab

    1. Channel value should be both.

    2. The Connection URI format should be similar to the following: wss://savg-webserver.kore.ai/audiosocket/genesys/?sipuri=xxx&token=xxx&botId=xxx&accountId=xxx&agentassist=true

    3. Get sipuri=sip:<sip-string> from UXO, Flow & Channels > Channels > Kore.ai Voice Gateway > SIP Numbers > Configure SIP Transfer > Transfer from IVR page.
      Transfer-from-IVR-page

    4. Use the following reference from Flow & Channels > Channels > Digital > Configured Channels > JWT App Details section of the XO application to fetch Bot ID, Account ID, Client ID, and Client Secret (for token generation).
      web-mobile-client

    5. Follow the steps of Using XO Platform APIs – Kore.ai Documentation to generate the token (token= <token>.)

  5. Add credentials in the Credentials tab.
    integration-configuration-credentials-tab

    1. Refer to Step-4 and use Bot Client ID and Client Secret as API Key and Client Secret respectively.

    2. These credentials are used to validate the audiostream signature by Kore.

  6. Click Save.

Step 6: XO 11 Configuration Notes

For the configured App, ensure at least one Dialog Task has been configured for Agent AI use. dialog-settings-page

Where to find configuration settings

You can find the necessary information in Flows & Channels > Digital > Web/Mobile Client. jwt-app-details