Dial menu

This activity offers a caller a menu of options, prompting the caller to select service options by entering a configured digit or speaking a response. When ASR is used, Mitel recommends asking the caller to say the requested response name instead of a numeric response to make it easier for ASR to recognize the response. For example, "Press 1 or say Service to reach the service department". The workflow will branch to different activities depending on the caller's selection.

Table 1. Dial menu action - Inputs
Parameters	Description
CallId	Unique identifier for the active call.
AudioSource	The name of the prompt to be played if the option to "Use existing greeting" is selected.
TTSText	The text to be played to the caller if the option "Text to speech" is selected.
TTSVoice	The voice to be used to play the TTS text if the option "Text to speech" is selected. For the complete list of supported languages and voices for Text-to-Speech (TTS), refer to the Amazon Polly Developer Guide.
MinDigits	If the caller is expected to enter digits, this is the minimum number of digits required to be entered. If no digits are expected, the value should be 0.
MaxDigits	If the caller is expected to enter digits, this is the maximum number of digits that can be entered. If no digits are expected, the value should be 0.
RepeatTimes	The number of times that the greeting will be repeated if the caller is expected to respond to the greeting and no response is received before the timeout.
TerminateOnAbandon	Indicates whether the workflow will exit if the caller hangs up.
TerminatingDigit	If the caller is expected to enter digits, entering this digit will return the digits entered, even if the timeout has not been reached, or the maximum number of allowed digits has not been entered.
EnterDigitTimeoutSeconds	If the caller is expected to respond to the greeting, this is the number of seconds the workflow will wait for the response (digits or ASR) before timing out.
UseASR	Indicates whether the caller can respond to the greeting with speech.
ASRLanguage	If `UseASR` is enabled, this parameter indicates the language to be used for ASR. For the complete list of supported languages and voices for ASR, refer to the Amazon Transcribe Developer Guide.
ResetRepeatCount	This indicates whether the RepeatTimes value will be reset when the action starts. It is useful if a GoTo action is used to point back to the Greeting action, so that the repeat count can be continued from the previous iteration and not reset.
ASRInitialSilenceDetection	If `UseASR` is enabled, this parameter indicates the numeric value representing the number of milliseconds to wait for the caller to begin speaking after the message plays before terminating the activity due to no response. If the value is greater than 0, the length of the message will automatically be added to this value, so that the system will wait for the greeting to complete and then apply the `ASRInitialSilenceDetection` value. If the value is 0, the system will wait up to 5 minutes for a response before terminating the activity. The value can range from 100-59000 milliseconds.
ASRSilenceDetection	If `UseASR` is enabled, this parameter indicates the numeric value representing the number of milliseconds of silence allowed before speech detection terminates. The value can range from 100-59000 milliseconds.
AllowBargeIn	Select True or False to specify whether caller input through DTMF digit entry or ASR will be accepted before the greeting completes. If the value is set to True, the caller is allowed to begin speaking or enter digits during the greeting, which will cancel the greeting and process the caller's input. If the value is set to False, the caller has to listen to the entire greeting before any caller input is accepted.

Table 2. Dial menu action - Outputs
Parameters	Description
CollectedDigits	If a response was received from the caller, this parameter returns the digits entered by the caller.
Success	Indicates whether the activity was completed successfully (value = True) or not (value = False)
Result	Returns the JSON formatted response from the activity.
TimesRepeated	Indicates the number of times that the greeting was repeated. A greeting will be repeated if a response is expected from the caller and is not received before the timeout.
CollectedSpeech	If an ASR response was received from the caller, this parameter returns the speech spoken by the caller.
BranchId	Returns "Tones" if digits or speech are collected from the caller. Returns "Failure" if no input is received from the caller or returns.
BranchResult	Returns the collected digits when BranchId returns "Tones".

↑