detectDigit

View as Markdown

detectDigit

  • detectDigit(params?): Promise<CallDetect> - See CallDetect for more details.

Detects when a digit is pressed in an audio stream. To gather digit input from a caller, please see prompt.

Parameters

NameTypeDescription
params?Object-
params.digits?stringThe digits to detect. Defaults to “0123456789#*”.
params.timeout?numberNumber of seconds to run the detector for. Defaults to 30.0.
params.waitForBeep?booleanWhether to wait until the device is ready for voicemail delivery. Defaults to false.

Returns

Promise<CallDetect> - See CallDetect for more details.

Example

1const detect = await call.detectDigit();
2const result = await detect.ended();
3
4console.log("Detect result:", result.type);