Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Gather Input On Call Widget


Studio uses Widgets to represent various parts of Twilio's functionality that can then be stitched together in your Studio Flow to build out robust applications that require no coding on your part.

(information)

Info

New to Twilio Studio? Check out our Getting Started Guide!

The Gather Input on Call Widget allows you to gather a user's keypress or voice input while they are on a call. This Widget will collect DTMF keypresses or text from speech recognition(link takes you to an external page), which you can then save for your own data purposes or send along to another Widget to send your user down the right path.

Gather input on call widget.{{first_name}}, and SSML like <emphasis level="strong">Thanks for calling!</emphasis>.N/ALanguageLanguage and regional dialect for the message being said if you selected "Say a Message"Select a supported language from the dropdown, or or enter a Liquid variable for dynamic selectionen-US (U.S. English)Message voiceThe voice that will read your message on the callSelect a supported voice from the dropdown or enter a Liquid variable for dynamic selection. Note that the dropdown will not populate until you select a languageAliceURL of audio fileThe URL of media to play, if you selected "Play a Message"https://api.twilio.com/cowbell.mp3N/ANumber of loopsThe number of times your message will loopAny positive integer between 1 and 991
(information)

Info

Studio Say/Play and Gather widgets now support SSML.

(information)

Info

For a list of supported Amazon Polly and Neural voices and dialects that you can reference with Liquid variables when setting Message Language and Voice, see this list.

Keypress options for Gather Input on Call

keypress-options-for-gather-input-on-call page anchor

A number of additional options are available when configuring the Gather Input on Call Widget to accept DTMF keypresses as input.

NameDescriptionSupported ValuesDefault
Stop gathering after __ secondsTime in seconds that the Flow will wait for a caller to press a key0 - 30 seconds5 seconds
Stop gathering on keypress?Stop gathering digits after a user presses a specific key. If "no," the Widget will gather and submit all keypresses when the Stop Gathering After timeout is reached or the expected Number of Digits are collectedYes or NoYes
Stop gathering on keypress ___The key that triggers data submission of a user's inputDigits 0-9, #, *#
Stop gathering after number of digitsThe number of digits you are expecting from a caller. A caller's input will be submitted as soon as this number of keypresses has been reached.0-30N/A
(warning)

Warning

Note that the value set for Stop Gathering Keypress is a control key, meaning that its value is not submitted with the rest of the gathered digits. For example, if your Stop Gathering On Keypress is # and a user enters 123#, only 123 will be submitted with your data.

Speech recognition options for Gather Input on Call

speech-recognition-options-for-gather-input-on-call page anchor

Consider the following options when configuring the Gather Input on Call Widget to accept a caller's speech as input:

NameDescriptionSupported ValuesDefault
Speech recognition languageThe language Twilio's speech engine will try to recognizeSelect a supported language from the dropdown, or or enter a Liquid variable for dynamic selectionen-US (U.S. English)
Speech recognition hintsA list of comma-separated values that give Twilio's speech engine specific words you expect to hear from your callerscomma-separated list of words (e.g., "sales, reservations, hours")N/A
Profanity filterRedact profanity from speech resultsTrue or FalseTrue

Advanced speech settings

advanced-speech-settings page anchor

You may choose to enable a few advanced speech settings in the Gather Input on Call Widget by expanding the Advanced speech settings box in the Widget configuration panel.

Advanced settings for Gather Input on Call widget can be toggled by clicking on the carat (^) underneath all other configuration settings.Rate this page:

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.