Relay.Calling.PromptAction

This object returned from one of asynchronous prompt methods that represents a prompt attempt that is currently active on a call.

Properties

Property	Type	Description
`result`	`Relay.Calling.PromptResult`	Final result of this prompt
`state`	`string`	Current state
`completed`	`boolean`	Whether the prompt attempt has finished
`payload`	`object`	Payload sent to Relay to start prompt
`controlId`	`string`	UUID to identify the prompt

Methods

stop

Stop the action immediately.

Parameters

None

Returns

Promise<StopResult> - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Ask user to enter a PIN and force-stop the action after 5 seconds.

1 async function main() {
2   const collect = {
3     type: 'digits',
4     digits_max: 3,
5     initial_timeout: 10,
6     text: 'Please, enter your 3 digit PIN.'
7   }
8   const action = await call.promptTTSAsync(collect)
9 
10   // ...
11 
12   setTimeout(async () => {
13     const stopResult = await action.stop()
14   }, 5000)
15 }
16 
17 main().catch(console.error)

volume

Control the volume of the playback.

Parameters

Parameter	Type	Required	Description
`volume`	`number`	✓	Volume value between -40dB and +40dB where 0 is unchanged

Returns

Promise<PromptVolumeResult> - Promise object that will be fulfilled with a Relay.Calling.PromptVolumeResult object.

Examples

Start the prompt and increase the playback volume.

1 async function main() {
2   const collect = {
3     type: 'digits',
4     digits_max: 3,
5     text: 'Please, enter your 3 digit PIN.'
6   }
7   const action = await call.promptTTSAsync(collect)
8 
9   const volumeResult = await action.volume(5.0)
10 }
11 
12 main().catch(console.error)