Interface SvamlActionRunMenu
- All Superinterfaces:
SvamlAction
Plays an interactive voice response (IVR) menu to the callee. This menu can play pre-recorded
files or text-to-speech messages, collect DTMF tones, and trigger the Prompt
Input Event (PIE) callback towards your backend, notifying you of the actions the callee
took. Available to use in a response to an Incoming
Call Event callback or an Answered
Call Event callback. Also be used in combination with the Conferences
endpoint of the Calling API.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Dedicated Builderstatic class
The name property. -
Method Summary
Modifier and TypeMethodDescriptionstatic SvamlActionRunMenu.Builder
builder()
Getting buildergetBarge()
'Barging' means that the user can press a DTMF digit before the prompt has finished playing.Enables voice detection.The voice and language you want to use for the text-to-speech message.Selects the menu item from themenus
array to play first.getMenus()
The list of menus available.
-
Method Details
-
getBarge
Boolean getBarge()'Barging' means that the user can press a DTMF digit before the prompt has finished playing. If a valid input is pressed, the message will stop playing and accept the input. Ifbarge
is disabled, the user must listen to the entire prompt before input is accepted. By default, barging is enabled.- Returns:
- barge
-
getLocale
String getLocale()The voice and language you want to use for the text-to-speech message. This can either be defined by the ISO 639 locale and language code or by specifying a particular voice. Supported languages and voices are detailed here. If using theenableVoice
to enable voice detection, thelocale
property is required in order to select the input language.- Returns:
- locale
-
getMainMenu
String getMainMenu()Selects the menu item from themenus
array to play first.- Returns:
- mainMenu
-
getEnableVoice
Boolean getEnableVoice()Enables voice detection. If enabled, users can say their answers to prompts in addition to entering them using the keypad.- Returns:
- enableVoice
-
getMenus
The list of menus available. The menu with theid
value ofmain
will always play first. If no menu has anid
value ofmain
, an error is returned.- Returns:
- menus
-
builder
Getting builder- Returns:
- New Builder instance
-