Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Design
Develop
Dialog Task
Working with User Intent Node
Working with the Dialog Node
Working with Entity Node
Supported Entity Types
Working with Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Working with Message Nodes
Working with the Confirmation Nodes
Working with Service Node
Implementing Custom Authentication
Enabling 2-way SSL for Service nodes
Working with Script Node
Working with Agent Transfer Node
Working with WebHook Node
Defining Connections & Transitions
Managing Dialogs
Prompt Editor
Action & Information Task
Working with Action Tasks
Working with Information Tasks
Establishing Flows
Alert Tasks
Working with Alert Tasks
Managing Ignore Words and Field Memory
Knowledge Tasks
Knowledge Ontology
Building Knowledge Graph
Importing and Exporting Bot Ontology
Knowledge Extraction
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
NLP Settings and Guidelines
Bot Intelligence
Overview
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talking to Bot
Utterance Testing
Batch Testing
Recording Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Universal Bots
Defining
Creating
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Kore.ai Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Web Socket Connect & RTM
Using the BotKit SDK
Installing the BotKit SDK
BotKit SDK Configuration
Events for the BotKit SDK
Functions for the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Enrollment
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Overview
Using Single Sign-On
Cloud Connector
Analytics
Billing
Bot Store
Overview
Creating a Kore.ai Bot Account
Adding a Kore.ai Bot
Choosing a Channel for a Bot
Interacting with a Kore.ai Bot
Setting Up Web Service Alerts
Setting Up RSS Alerts
Setting Up the Kore.ai Webhook Bot
Custom Kore.ai Bots
Bots for your Customers FAQs
Bots for your Workforce FAQs
Adding Bots
Contacting Kore.ai Support
Setting Up Filters
Bot Store Settings
How Tos
Context Switching
Using Traits
Live Agent Transfer
Schedule a Smart Alert
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. Advanced Topics
  5. IVR Integration
  6. IVR Integration

IVR Integration

When it comes to automating customer interactions, IVR systems have proven to be among the top choices for organizations. But if you are using an Interactive Voice Response (IVR) system for your customer service, odds are you might have encountered these two issues quite often:

  • Non-Intuitive Interface: IVR systems do not simply let the customers state their need. They make the users go through a plethora of menu options from which to select before finding their intent. Even if they allow users to express their intent at first go, the backend programs can only understand a limited number of phrases.
  • Static Flows: IVR systems use static call flows that do not align with the nonlinear and contextual nature of human interactions. Take the following example of a customer trying to Book Flight tickets:
    User: Book me a ticket to NYC
    IVR: Sure, for which date?
    User: Wait, will it rain there this Sunday?
    IVR: Sorry, I don’t understand the input.

    Conventional IVR system leaves limited room for the users to articulate their requests beyond the rigid program flows.

Kore.ai IVR Integration Support

Kore.ai allows you to give a conversational makeover to your IVR system. It lets you build chatbots with human-like conversation capabilities and integrate them with your existing IVR system, thus taking your organization’s customer service experience to a whole new level.

The following features enable  the seamless integration of your Kore.ai Bots with your existing IVR:

  • Native VXML Support: Built-in support to parse and generate W3C compliant VXML files.
  • Hybrid integration: Flexibility to build use cases or dialogs on the Bots Platform, which can work in-sync with the IVR dialogs.
  • Discourse Analyzer: Kore.ai’s discourse analyzer helps enterprises generate conversation flows using historical chat or call transcripts. Chat and call transcripts are analyzed using neural network-based machine learning models to identify intents and discourse patterns to fulfill a specific intent.
  • Granular Call Flow Support: Ability to define all the call flow elements such as grammar, prompts, retry and time-out periods. Kore.ai supports call termination handlers, allowing you to end calls or invoke dialogs in case of exceptions.

Setting Up

Setting up IVR integration involves the following three steps:

  1. Configure Bot Settings: Define IVR settings such as transcription options, welcome messages, standard responses and VXML properties
  2. Dialog Definition: Define Dialog by configuring node-specific grammar, prompts, and call flow behavior like time-out, retries.
  3. Channel Setup: Set up authentication, configure WebHook in your IVR system and enable channel

Bot Settings

Step 1: IVR Settings for a Bot

As the first step of the integration, you first need to enable the IVR settings for the bot and define the Transcription options and VXML properties. These settings act as the default for the bot. You may override VXML properties defined at the bot level by defining custom values at the node level of the Dialog tasks.
To configure IVR settings for the bot

  1. Open the Bot for which you want to integrate the IVR.
  2. Hover over the Left navigation panel and select Channels
  3. Locate and click IVR Settings. The IVR Panel with Instructions opens.
  4. From the Configuration tab, either create or select the App to associate with the IVR channel.
  5. From the Settings tab set the configurations.
    Note: The IVR Settings options on Dialog task nodes, Standard Responses, and Welcome Message become visible only when you enable IVR Settings for the bot.

  6. (Optional) To enable an external transcription engine, under Enable Transcription, select Yes.
    1. Enter the source of the transcription engine in the textbox that appears below.
      Note: Bots Platform supports all UNIMRCP-encoded voice-to-text services. Only if you select the Enable Transcription option for the bot, the platform allows you to do away with defining grammar during configuring IVR settings for any node (described in Step 2).
  7. Enter the following details to complete the setup:
    Field Description
    IVR Data Extraction Key Specify the syntax to extract the filled data
    Call Termination Handler Select the name of the Dialog task that you want to use as the call termination handler.
    VXML Properties Click Add Property. Enter property names and values to use in defining the VXML definition.

    Note: You should these properties and values in the VXML files for all call flows in the IVR system.
    Timeout Prompt Enter the default prompt text to play when the user doesn’t provide the input within the timeout period. If you do not specify a Timeout Prompt for any node, this prompt take its place.
    No Match Prompt Enter the default prompt text to play when user input is not present in the defined grammar. If you do not specify a No Match Prompt for any node, this prompt take its place.
    Barge-In Select whether you want to allow a user input while a prompt is in progress. If you select no, the user cannot provide input until IVR completes the prompt.
    Timeout Select the maximum wait time to receive user input from the drop-down list, from 1 second up to 60 seconds.
    No. of Retries Select the maximum number of retries to allow. You can select from just 1 retry up to 10 retries.
    Log Select Yes if you want to send the chat log to the IVR system.
Customize Standard Responses

After configuring the IVR settings for the bot, you can optionally customize the standard responses. Follow these steps to do so:

  1. Hover over the left navigation panel of the bot and click Natural Language -> Default Conversation.
  2. Click the Standard Responses tab.
  3. Click any sub-tab on the Standard Responses window, and hover over the desired field.
  4. Click Add IVR settings and enter the required values.

Refer to the next section for field references of each IVR setting.

Dialog Settings

Step 2: Setting Up IVR Settings for Dialog Nodes

The IVR Properties panel appears for a node when one of these conditions is met when the Enable IVR Settings in the IVR Settings page for the bot is enabled. On the IVR Properties panel for a node, you can enter node-specific prompts, grammar, as well as parameters for call-flow behavior such as time-out and retries.

IVR settings apply only for the following nodes and message types:

  • Entity Node
  • Message Node
  • Confirmation Node
  • Standard Responses
  • Welcome Message
Note: Most IVR settings are the same for all nodes, with a few exceptions.
Configuring IVR Settings for a Node

To configure IVR settings for a node, hover over the node in the Dialog task and click the Settings icon. On the Properties panel, click the IVR icon.

IVR Settings Field Reference
The following sections provide detailed descriptions of each IVR setting, including descriptions, applicability to nodes, default values and other key information.

  • Prompts: 
    • You can enter prompts in one of these formats: Plain text, Script, File location of an audio file. If you want to define JavaScript or attach an audio file, click the icon before the prompt text message box and select a mode. By default, it is set to Text mode.
    • You can enter more than one prompt messages of different types. You can define their order of sequence by dragging and dropping them.
    • Multiple prompts are useful in scenarios where the prompt has to be played more than once, to avoid repetition, since the prompts are played in order.
  • Initial Prompts
    Apply to: Entity, Confirmation, Message nodes; Standard Responses and Welcome Message
    Prompts that are played when the IVR first executes the node. If you do not enter a prompt for a node, the default user prompt for the node plays by default. If you do not enter a prompt for Standard Responses and Welcome Message, the default Standard Response and Welcome Message are played by default.
  • Timeout Prompts
    Apply to: Entity, Confirmation; Standard Responses and Welcome Message
    Prompts that are played on the IVR channel when the user has not given any input within the specified time. If you do not enter a prompt for a node, the default Error Prompt of the node is played. Standard Responses and Welcomes have a default Timeout Prompt that plays if you don’t define No Match Prompts.
  • No Match Prompts
    Apply to: Entity, Confirmation; Standard Responses and Welcome Message
    Prompts that are played on the IVR channel when the user’s input has not matched any value in the defined grammar. If you do not enter a prompt here or select No Grammar option for an Entity or Confirmation node, the default Error Prompt of the node is played. Standard Responses and Welcomes have a default No Match Prompt that plays if you do not enter it.
  • Error Prompts
    Apply to: Entity, Confirmation; 
    Prompts that are played on the IVR channel when user input is invalid Entity type. If you do not enter a prompt here, the default Error Prompt of the node is played.
  • Grammar
    Applies to: Confirmation; Standard Responses and Welcome Message
    Define the grammar that should be used to detect user’s utterance. You can define one or more grammars for a node.

    Note: If the Enable Transcription option is enabled for the bot along with specifying the source of the transcription engine, defining grammar isn’t mandatory.

    To define the grammar

    1. Select Speech or DTMF as the input type.
    2. Source of grammar can be Custom or Link from the drop-down list
      1. For Custom, write VXML grammar in the textbox below.
      2. For Link, enter the URL of the grammar. Ideally, the URL should be accessible to the IVR system so that the resource can be accessed while executing the calls at runtime.
  • Advanced Options
    These properties override the properties set in the Bot IVR Settings page.

    Field Description
    Timeout Select the maximum wait time to receive user input from the drop-down list, from 1 second up to 60 seconds. The default value is the same as defined in the Bot IVR Settings page.
    No. of Retries Select the maximum number of retries to allow. You can select from just 1 retry up to 10 retries.
    The default value is the same as defined in the Bot IVR Settings page.
    Behavior on Exceeding Retries
    (applies only to entity node)
    Define behavior when either the timeout or number of retry attempts exceed the specified limit. Options include:

    • Invoke CallTermination Handler
    • Initiate Dialog: Select a Dialog task from the list of bot tasks.
    • Jump to specific node in current task: Select a node from the list of nodes in the current Dialog task.
    Barge-In Select whether you want to allow a user input while a prompt is in progress. If you select no, the user input is not considered until the prompt is completed. The default value is No.
    VXML Properties Click Add Property. Enter property names and values to use in defining the VXML definition. These values defined for a node or a standard response override the global VXML properties defined in the Bot IVR settings page.
    Log Select Yes if you want to send the chat log to the IVR system. The default value is No.
    Recording Define the state of recording to be initiated. The default value is Stop.

Channel Override
You can write JavaScript code for the prompts in Entity nodes, Standard Messages, and Welcome Message to take full control of the call behavior. In such cases, you should write channel override JavaScript that generates the entire VXML code as the Bots Platform doesn’t append the IVR VXML snippet, but substitutes it with the code you write.

Follow these steps to write channel override for an Entity node:

  1. Hover over the Entity node and click the icon.
  2. UnderUser Prompts or Error Prompts section, click Manage Prompts or Manage Errors respectively.
  3. Click Add Prompt Message.

  4. From the Channels drop-down list, select IVR.
  5. On the Message editor, click JavaScript.

  6. Define JavaScript that generates the entire VXML code, and click Save. 

Follow these steps to write channel override for a Standard Response:

  1. Hover over the select Standard Response and select Add Channel Response > IVR.
  2. On the Add Channel Overrides window, select the following:
    1. Channel: IVR
    2. Task and node for which to write the override.
  3. Under the Response editor, click Advanced Mode and type the code.

Channel Settings

Step 3: Setting Up IVR Channel for the Bot

After configuring IVR Settings at both the Bot and the Dialog levels, you should configure IVR Channel for the bot. IVR channel provides a generic integration to connect bots with IVR systems. Kore.ai platform generates required VXML files to be exchanged as part of bot interaction with the end user via the IVR systems.
Enabling IVR Channel and Associating an APP
Kore.ai Bots require a JWT token to authenticate the incoming requests from IVR. For generating JWT token, you should associate an app with the bot. You can select any of the existing Apps available in your Kore.ai account or create a new app.

  1. Hover over the side navigation panel of the bot and click Channels.
  2. On the Channels page, click IVR. The IVR Channel Instructions page opens.
  3. Click the Configuration tab.
  4. From the Select App drop-down list, select an existing App. If you do not have any app to associate the bot with, click Add.
  5. Copy the following:
    1. WebHook URL: For calling the bot from IVR.
    2. Client Secret: To generate JWT token that must be appended to the WebHook URL.
  6. Select Yes for Enable Channel.

Generating JWT Token

  1. Go to https://jwt.io/ nd scroll down the page to the Decoded section.
  2. Replace the contents in the Payload box with
    • sub – set to user name or call Id; and
    • appId – set to Client ID of the app copied in the previous section
  3. Scroll to Verify Signature section. In the Your-256-bit secret placeholder field, enter the copied Client Secret.
  4. Click Share JWT. The JWT token gets copied.
  5. JWT has to be passed in the IVR hook URL as value for the query parameter “token”:
    https://bots.kore.ai/ivr/hooks/{{botId}}?token={{JWT}}

Calling Bot from IVR Call flow
You can pass data to the bot from the IVR call flow using VXML <subdialog> as shown in the picture below. The subdialog src should be Webhook URL with JWT Token which takes the following parameters as Input

  • message : Message from User
  • from: Unique User’s Identity Ex: Phone Number
  • to: Bot Stream Id

The endOfConversation variable should be processed from the data returned from the sub-dialog. If the value is set to true, it indicates that the dialog execution (conversation) is complete. It can be a triggering point to end the call with the user.

Menu