prompt

Play a prompt and wait for input. The input can be received either as digits from the keypad, or from speech, or both depending on what [prompt parameters](#parameters) are set. | Name | Type | Default | Description | |:-|:|:--|:| | promptRequired | object | - | An object that accepts the [prompt parameters](#parameters). | ## **prompt Parameters** {#parameters} | Name | Type | Default | Description | |:-|:--|:--|:| | playRequired | string \| string[] | - | Either a [playable sound](#playable-sounds), an array of [playable sounds](#playable-sounds) | | volumeOptional | number | 0 | Volume gain to apply to played URLs. Allowed values from -40.0 to 40.0. | | say_voiceOptional | string | Polly.Salli | Voice to use with say: for text to speech | | say_languageOptional | string | en-US | Language to use with say: for text to speech | | say_genderOptional | string | female | Gender to use with say: for text to speech | | max_digitsOptional | integer | 1 | Number of digits to collect | | terminatorsOptional | string | - | Digits that terminate digit collection | | digit_timeoutOptional | number | 5.0 seconds | Time in seconds to wait for next digit | | initial_timeoutOptional | number | 5.0 seconds | Time in seconds to wait for start of input | | speech_timeoutOptional | number | - | Max time in seconds to wait for speech result | | speech_end_timeoutOptional | number | - | Time in seconds to wait for end of speech utterance | | speech_languageOptional | string | - | Language to detect speech in | | speech_hintsOptional | string[] | - | Expected words to match | :::note By default, only digit input via keypad is enabled. When **at least one** speech input based parameter is set (speech_timeout, speech_end_timeout, speech_language or speech_hints), speech input is enabled and digit input is disabled. To enable speech and digit based input collection at once, set at least one speech input parameter and at least one digit input based parameter (max_digits, terminators, digit_timeout, and initial_timeout). ::: ## **Playable sounds** import PlayableSounds from ./_sharedtables/playable_sounds.mdx; ## **Variables** Read by the method: - **say_voice:** (in) - optional voice to use for text to speech. - **say_language:** (in) - optional language to use for text to speech. - **say_gender:** (in) - optional gender to use for text to speech. ## **Possible values for Voice, Language, and Ringtone** import VoiceTable from ./_sharedtables/voicetable.mdx; ### Set by the method - **prompt_result:** (out) - failed, no_input, match_speech, match_digits, or no_match. - **prompt_value:** (out) - the digits or utterance collected. - **prompt_digit_terminator:** (out) - digit terminator collected, if any. - **prompt_speech_confidence:** (out) - speech confidence measured, if any. ## **Examples** The [play method](./play.mdx) also has examples related to playing sounds from URLs. The interface for playing sounds for play and prompt is identical. ### Play prompt and wait for digit press yaml andJson version: 1.0.0 sections: main: - prompt: play: say:Input a number - switch: variable: prompt_value default: - play: url: say:You didnt press one - transfer: dest: main case: 1: - play: url: say:You pressed one ### Using terminators yaml andJson version: 1.0.0 sections: main: - prompt: play: say:PIN number please max_digits: 10 terminators: *#5 - play: url: say: %{prompt_value} was terminated by %{prompt_digit_terminator} ### Play prompt and wait for digit or speech yaml andJson version: 1.0.0 sections: main: - prompt: play: https://example.com/press_or_say_one.wav speech_language: en-US max_digits: 1 speech_hints: - one - two - three - four - five - six - seven - eight - nine - switch: variable: prompt_value default: - play: url: https://example.com/bad_input.wav - transfer: dest: main case: 1: - transfer: dest: https://example.com/sales.swml one: - transfer: dest: https://example.com/sales.swml ### Play prompt and collect digits, then pass the data to an external action yaml andJson version: 1.0.0 sections: main: - prompt: play: https://example.com/menu.wav - transfer: dest: https://example.com/post_next_menu In this case, the URL listed in transfer will be sent an HTTP POST request with all the [out variables](#set-by-the-method) (like prompt_value) already set. For more details on this behavior, refer to [transfer](./transfer.mdx) statements documentation.