***

id: 98d96bd9-b467-4b6b-9f69-d6933e01f719
title: CallDetect
slug: /node/reference/voice/call-detect
sidebar-title: CallDetect
description: >-
CallDetect object reference for detecting call conditions including answering
machines, fax tones, and DTMF digits during voice calls.
max-toc-depth: 3
----------------

[calldetectresult-4]: /docs/server-sdk/v3/node/reference/voice/call-detect

[link]: #ended

[voice-call-1]: /docs/server-sdk/v3/node/reference/voice/call/detect-answering-machine

[voice-call-2]: /docs/server-sdk/v3/node/reference/voice/call/detect-digit

[voice-call-3]: /docs/server-sdk/v3/node/reference/voice/call/detect-fax

[voice-call-4]: /docs/server-sdk/v3/node/reference/voice/call/amd

[voice-call]: /docs/server-sdk/v3/node/reference/voice/call/detect

Represents a current or past detecting session in a call. You can obtain instances of this class by starting a Detect session with one of the following methods:

* [`Call.detect`][voice-call]
* [`Call.detectAnsweringMachine`][voice-call-1]
* [`Call.detectDigit`][voice-call-2]
* [`Call.detectFax`][voice-call-3]

## Properties

### id

The unique id for this detecting session.

**Syntax:** `CallDetect.id()`

**Returns:** `string`

### type

The type of this detecting session.

**Syntax:** `CallDetect.type()`

**Returns:** `"machine"` | `"digit"` | `"fax"`| `"beep"`

### result

The result of the detecting session.

**Syntax:** `CallDetect.result()`

**Returns:**

| Detect Type                                                       | Type       | Event Values                                                                                                                                                                                                                                                                                                                                                                                                            |
| :---------------------------------------------------------------- | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`amd`][voice-call-4] \| [`detectAnsweringMachine`][voice-call-1] | `"string"` | <ul><li>**MACHINE**: Machine detected</li><li>**HUMAN**: Human detected - this is a final event</li><li>**UNKNOWN**: Unknown detection</li><li>**READY**: Machine is ready for voicemail delivery - This is a final event if `detect_interruptions=false` or `beep=true`</li><li>**NOT\_READY**: Machine voicemail has restarted, interrupting voicemail delivery. Only fired if `detect_interruptions=true`.</li></ul> |
| [`detectDigit`][voice-call-2]                                     | `"string"` | Possible digits detected: `0 1 2 3 4 5 6 7 8 9 # *`                                                                                                                                                                                                                                                                                                                                                                     |
| [`detectFax`][voice-call-3]                                       | `"string"` | <ul><li>**CED**: called station fax tone</li><li>**CNG**: calling station fax tone</li></ul>                                                                                                                                                                                                                                                                                                                            |

## Methods

### ended

* **ended**(): `Promise<CallDetect>` - See [CallDetectResult][calldetectresult-4] for more details.

Returns a promise which will get resolved only after the detecting session is completed.

#### Returns

`Promise<CallDetect>` - See [CallDetectResult][calldetectresult-4] for more details.

#### Example

```js
const detect = await call.detectDigit();
const result = await detect.ended();

console.log("Detect result:", result.type);
```

### stop

* **stop**(): `Promise<CallDetect>` - See [CallDetectResult][calldetectresult-4] for more details.

Stops the detect.

#### Returns

`Promise<CallDetect>` - See [CallDetectResult][calldetectresult-4] for more details.

#### Example

```js
const detect = await call.detectDigit();
await detect.stop();
```

### ~~waitForResult~~

* waitForResult(): `Promise<CallDetect>` - See [CallDetectResult][calldetectresult-4] for more details.

Returns a promise which will get resolved only after the detecting session is completed.

<Warning>
  This method is deprecated. See [ended][link] instead.
</Warning>