Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots's Approach Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Platform
How to Access Bot Builder
Working with 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
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
User Prompts
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Importing and Exporting
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Ranking and Resolver
NLP Detection
Advanced NLP Configurations
Bot Intelligence
Context Management
Session and Context Variables
Context Object
Dialog Management
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Manage Sessions
Bot Management
Bot Versioning
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using 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
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
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. IVR Support 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 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:’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. This is an out-of-the-box feature which is in Beta state. Contact our support team if you want to try this feature.
  • Granular Call Flow Support: Ability to define all the call flow elements such as grammar, prompts, retry and time-out periods. 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,
    1. You can use IVR Sandbox for testing your Bot, see below for details.
      IMP: If you save the configuration after associating an app without Enabling IVR Settings, the platform will pre-populate the required settings for Sandbox.
    2. Associate an App with the IVR channel – either by creating a new one or selecting an existing one.
    3. Use the WebHook URL provided in your external application.
  5. From the Settings tab set the configurations, enter the details to complete the setup, see here for details.

    If you have enabled IVR Sandbox, the following settings are required by the platform. These will be pre-populated if you do not enable the IVR settings. In case you have enabled the settings, ensure the values are the same as given below, sandbox may not respond as expected if you use different values:
    – Enable Transcription set to Yes,
    – transcription engine source set to builtin:speech/transcribe,
    – IVR Data Extraction Key set to userinput,
    – ASR Confidence Threshold Key set to userinput.confidence,
    – ASR Threshold Confidence set to 50

  6. (Optional) To enable an external transcription engine, under Enable Transcription, select Yes.
    • On enabling the transcription engine, a text box appears for entering the source of the transcription engine.
      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).

      See here for a detailed configuration for Grammar syntax.

  7. Once you have enabled the IVR channel, we recommend configuring the Telephony Welcome Event for IVR Settings. This would play a welcome message for users when they connect to the Bot via the IVR channel.
    For this:

    1. From Natural Language -> Event Handlers configure Telephony Welcome Event
    2. Click the Use Voice Call Properties button to open the voice settings section.
    3. Under the Initial Prompts text box, enter the message that needs to be played when the user connects to the Bot.
    4. For details regarding other configuration fields, refer to the Configuring voice call properties for a Node section.

Sandbox Configuration

Note: This option was introduced in ver 7.1 of the platform. It is not available for on-prem installation. offers an IVR Sandbox environment to instantly launch your bot for interactions over voice calls. This is particularly useful when a working IVR system is not feasible or available for testing your Bot over a voice channel. IVR Sandbox is an optional integration and it can coexist with your custom IVR integration.

Enabling this option will give you a Phone Number, Pin, and Secret. You can call your bot by using the phone number and PIN allocated for your bot to develop and test the bot with your teams. On receiving the valid Pin and Secret you will be connected to the Bot for interactions.

Once enabled you can access the IVR Sandbox interaction details by selecting the Test button on hover over the IVR icon from the channels page.


  • The platform supports only a limited number of concurrent lines hence calls to your bots via IVR Sandbox may not be responded to at times.
  • We strongly recommend you use IVR Sandbox only for serving internal testing purposes and not for the end-users of your bots as there might be some functional limitations.

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. 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 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 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. Refer here to get the JWT token, click here
  2. JWT has to be passed in the IVR hook URL as value for the query parameter “token”:{{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
  • <custom_variable>: any custom defined variables available at context.session.BotUserSession.ivr.<custom_variable>

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.