Represents a current or past prompting session in a call. You can obtain instances of this class by starting a Prompt with one of the following methods: - [Call.prompt](./voice-call.mdx#prompt) - [Call.promptAudio](./voice-call.mdx#promptaudio) - [Call.promptRingtone](./voice-call.mdx#promptringtone) - [Call.promptTTS](./voice-call.mdx#prompttts) #### Example Prompting for a PIN to be entered using the keypad, then waiting for the user to finish entering the PIN before proceeding with the next instructions. js import { Voice } from @signalwire/realtime-api; const client = new Voice.Client({ project: , token: , topics: [office], }); const call = await client.dialPhone({ from: +YYYYYYYYYY, to: +XXXXXXXXXX, }); // Prompt for digits const prompt = await call.promptTTS({ text: Please enter your PIN, digits: { max: 5, digitTimeout: 5, terminators: #*, }, }); const { digits } = await prompt.ended(); console.log(Entered PIN:, digits); ## Properties ### confidence Confidence level for the speech recognition result (if [type](#type) is speech), from 0 to 100. For example, 83.2. **Syntax:** CallPrompt.confidence() **Returns:** number ### digits The digits that have been collected (if [type](#type) is digit). For example, 12345. **Syntax:** CallPrompt.digits() **Returns:** string ### id The unique id for this prompt. **Syntax:** CallPrompt.id() **Returns:** string ### reason Alias for [type](#type), in case of errors. Use this field to check the reason of the error. **Syntax:** CallPrompt.reason() **Returns:** no_match | no_input | error ### terminator The terminator used to complete the prompt (if [type](#type) is digit). For example, #. **Syntax:** CallPrompt.terminator() **Returns:** string ### text The text that has been collected (if [type](#type) is speech). For example, hello whos there. **Syntax:** CallPrompt.text() **Returns:** string ### type The type of this prompt. **Syntax:** CallPrompt.type() **Returns:** error | no_input | no_match | digit | speech ## Methods ### ended ▸ **ended**(): Promise - See [CallPrompt](./callprompt.mdx) for more details. Returns a promise that is resolved only after this prompt finishes (or is stopped). #### Returns Promise - See [CallPrompt](./callprompt.mdx) for more details. #### Example js const prompt = await call.promptTTS({ text: Please enter your PIN, digits: { max: 5, digitTimeout: 2, terminators: #*, }, }); const { type, digits, terminator } = await prompt.ended(); ### setVolume ▸ **setVolume**(volume): Promise - See [CallPrompt](./callprompt.mdx) for more details. Changes the volume of the audio. #### Parameters | Name | Type | Description | |:|:|:--| | volume | number | Volume value between -40dB and +40dB. | #### Returns Promise - See [CallPrompt](./callprompt.mdx) for more details. #### Example js const prompt = await call.promptTTS({ text: Please enter your PIN, digits: { max: 5, digitTimeout: 2, terminators: #*, }, }); await prompt.setVolume(-20); ### stop ▸ **stop**(): Promise - See [CallPrompt](./callprompt.mdx) for more details. Stops the prompt. #### Returns Promise - See [CallPrompt](./callprompt.mdx) for more details. #### Example js const prompt = await call.promptTTS({ text: Please enter your PIN, digits: { max: 5, digitTimeout: 2, terminators: #*, }, }); await prompt.stop(); ### ~~waitForResult~~ ▸ **waitForResult**(): Promise - See [CallPrompt](./callprompt.mdx) for more details. Returns a promise that is resolved only after this prompt finishes (or is stopped). :::caution This method is deprecated. See [ended](#ended) instead. :::