detectFax

View as Markdown

detectFax

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

Detects the presence of a fax machine.

Parameters

NameTypeDescription
params?Object-
params.timeout?numberNumber of seconds to run the detector for. Defaults to 30.0.
params.tone?"CED" | "CNG"The fax tone to detect: CED or CNG. Defaults to CED.
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.detectFax();
2const result = await detect.ended();
3
4console.log("Detect result:", result.type);