To add Twilio Voice as a channel to your Kore.ai bot, you will need to get a Twilio phone number and setup webhook integration to communicate with the bot. Adding the Twilio Voice channel to your Kore.ai Bot allows end users for your bot to interact with your bot using their Twilio Voice accounts. To add the Twilio Voice channel to your Bot, you will need to:
- Get a Twilio Number- To enable Twilio Voice channel, you will need to create a Twilio phone number to be associated with this bot.
- Setup Integration- To setup integration, you will need to create a TwiML App and get Webhook URL details from Configurations tab of Twilio Voice channel page to enter in the ‘Request URL’ for Voice to activate channel.
- Associate TwiML App with Twilio Phone Number– To associate TwiML App with Twilio Phone Number, you will need to configure your preferred active Twilio number with TwiML App.
- Optional Configuration for Setting-up Agent Transfer- To use Agent Transfer functionality you will need to setup the Kore.ai Agent Transfer SDK.
- Enable Channel- Once you setup integration and complete configuration, you will need to enable channel.
Note: Twilio Voice should ideally be enabled for bots that are specifically built to work on voice based channels. Please review the following constraints before enabling Twilio Voice as a channel for this bot:
- Enterprise Bots that require user’s authorization to communicate with the bot are not supported on Twilio Voice.
- Tasks that require user’s authorization to communicate with external systems should ideally be not included.
- Webhook Nodes work asynchronously and are currently are not supported on Twilio Voice.
- Use only dialog tasks for best user experience on Twilio Voice channel.
- Ensure that the bot responses you are going to configure for Twilio Voice are brief, plain text messages only.
- Bot receives user’s voice response from Twilio Voice only after few moments of silence at user’s end and this could appear as a lag to end user.
Pre-requisites to add the Twilio Voice Channel
- Login to your Twilio Voice account to create a new Twilio number to be associated with your bot.
- To get a Twilio Number:
- Navigate to Products and Services menu and select Phone Numbers.
- Create a new Twilio phone number to be associated with this bot. If you already have a Twilio phone number that you want to associate with this bot, then you can proceed to the next steps.
Please note that the image may change depending on your Twilio account type.
- To setup integration,
- To associate TwiML App with Twilio Phone Number:
- Navigate to Manage Numbers menu under Phone Numbers.
- From Active Numbers section, select the number you would like to associate the TwiML App.
- Under Voice & Fax section, select TwiML App as the choice in Configure With field.
- A new field TWIML APP will be displayed and from this, select the app you have configured in the previous steps.
- Click on Save to complete this app association.
- Optionally, you can also setup Agent Transfer functionality to transfer user’s call conversation to another Twilio number. For this, you need to configure the Kore.ai Agent Transfer SDK.
- You may download the Agent Transfer SDK from Kore.ai GitHub repository and define ‘data.message’, ‘transferCallToAgent’ and ‘agentPhonenumber’ parameters.
- ‘data.message’: Define the message to be read out to the end user when call is transferred to agent is initiated.
- ‘transferCallToAgent’: Set this flag to True to enable Agent Transfer and False to disable.
- ‘agentPhonenumber’: Provide your Twilio phone number to which the user call conversation is to be transferred to.
- You may download the Agent Transfer SDK from Kore.ai GitHub repository and define ‘data.message’, ‘transferCallToAgent’ and ‘agentPhonenumber’ parameters.
To Enable Twilio Voice Channel
- In the Bots section of the Bot Builder, click the Bot that you want to add the Twilio Voice channel.
- On the Channels tab, click the Twilio Voice icon. The Twilio Voice Channel page gets displayed.
- To complete the Channel setup, navigate to the Configurations tab.
- Enter your Twilio Number to be associated with Kore.ai bot.
- Select a Language to be used for communication with the bot by end-users.
- In the Enable Channel section, select Yes, and then click Save to complete user creation process and channel activation.
- From the Voice Call Properties tab, enter the following details to configure the channel level voice properties:
Field Description End of Conversation Behavior This property can be used to define the bot behavior at the end of the conversation. The options are: - Trigger End of Conversation Behavior and configure the Task, Script or Message to be initiated. See here for details.
- Terminate the call.
Call Termination Handler Select the name of the Dialog task that you want to use as the call termination handler when the call ends in error. 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. 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. - Once you have enabled the Twilio channel, we recommend configuring the Welcome Event for Voice Call Settings. This would play a welcome message for users when they connect to the Bot via the Twilio channel.
For this:- From Natural Language -> Default Conversation -> Event Handlers configure Welcome Event
- Select Show Message under Event Configuration
- Click the Add Voice Call Settings button to open the Voice Call settings window
- Under the Initial Prompts text box, enter the message that needs to be played when the user connects to the Bot.
- For details regarding other configuration fields, refer to the Configuring Voice Call Settings for a Node section below.
Dialog Settings
Setting Up Voice Call Properties for Dialog Nodes
On the Voice Call Properties panel for a node, you can enter node-specific prompts and parameters for call-flow behavior such as time-out and retries. If not enabled, you can use the enable button to enable the Voice Call settings for the Bot and then customize for the specific node.
Voice Call settings apply only for the following nodes and message types:
- Entity Node
- Message Node
- Confirmation Node
- Standard Responses
- Welcome Message
Configuring Voice Call Settings for a Node
To configure Voice Call settings for a node, hover over the node in the Dialog task, and click the Settings icon. On the Properties panel, click the Voice Call icon.
Voice Call Settings Field Reference
The following sections provide detailed descriptions of each Voice Call setting, including descriptions, applicability to nodes, default values and other key information, as applicable to the Twilio channel
- Prompts:
- You can enter prompts in one of these formats: Plain text, Scrip. If you want to define JavaScript, 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 Twilio 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 Twilio 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 – Not applicable for Twilio channel
- Error Prompts
Apply to: Entity, Confirmation;
Prompts that are played on the IVR channel when user input is an invalid Entity type. If you do not enter a prompt here, the default Error Prompt of the node is played.
- You can enter prompts in one of these formats: Plain text, Scrip. If you want to define JavaScript, click the icon before the prompt text message box and select a mode. By default, it is set to Text mode.
- Grammar
Applies to: Confirmation; Standard Responses and Welcome Message
Define the grammar that should be used to detect the user’s utterance. You can define one or more grammars for a node.Transcription option is enabled by default for the bot along with specifying the source of the transcription engine, defining grammar isn’t mandatory.To define the grammar
- Select Speech as the input type. Input type DTMF is disabled for the Twilio channel.
- The Source of grammar is set to Custom. The link option is not available for the Twilio channel.
Enter a list of words or phrases to be used as ‘hints’ in TwiML
- 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 a specific node in the 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.
Editing the Twilio Voice Channel
To edit the Twilio Voice channel, hover your mouse over the channel to modify, and then click the Settings icon to display the command menu as shown in the following illustration.
Select one of the following commands to modify the channel:
- Disable/Enable – Click Disable to temporarily disable use of the Twilio Voice for your Bot.To enable use of the Twilio Voice channel, Click Enable.
- Delete – Click Delete, and then click OK in the Delete Confirmation dialog to permanently delete the Bot channel configuration.