[**Documentation**](index.md)

***

[Documentation](packages.md) / Vonage Voice

# Vonage Voice SDK for Node.js

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/voice?label=%40vonage%2Fvoice&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license]

<img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px" alt="Vonage" />

This is the Vonage Voice SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup].

For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/).

If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/voice/v2_TO_v3_MIGRATION_GUIDE.md)

* [Installation](#installation)
* [Usage](#usage)
* [Promises](#promises)
* [Testing](#testing)

## Installation

We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Voice API.

### With NPM

```bash
npm install @vonage/voice
```

### With Yarn

```bash
yarn add @vonage/voice
```

## Usage

### As part of the Vonage Server SDK

If you are using this SDK as part of the Vonage Server SDK, you can access it as the `voice` property off of the client that you instantiate.

```js
const { Vonage } = require('@vonage/server-sdk');

const credentials = {
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
};
const options = {};
const vonage = new Vonage(credentials, options);

vonage.voice.getCall(CALL_UUID)
  .then(resp => console.log(resp))
  .catch(err => console.error(err));
```

### Standalone

The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Voice API. All you need to do is `require('@vonage/voice')`, and use the returned object to create your own client.

```js
const { Auth } = require('@vonage/auth');
const { Voice } = require('@vonage/voice');

const credentials = new Auth({
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
});
const options = {};
const voiceClient = new Voice(credentials, options);
```

Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options)

## Promises

Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response.

```js
const resp = await vonage.voice.getCall(CALL_UUID)

vonage.voice.getCall(CALL_UUID)
 .then(resp => console.log(resp))
 .catch(err => console.error(err));
```

## Testing

Run:

```bash
npm run test
```

[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk
[license]: _media/LICENSE.txt

## Enumerations

### AdvancedMachineDetectionMode

Defined in: [voice/lib/enums/AdvancedMachineDetectionMode.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/AdvancedMachineDetectionMode.ts#L4)

Enum representing different modes for advanced machine detection in the Connect NCCO action.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="default"></a> `DEFAULT` | `"default"` | Default mode, used for advanced async machine detection, including beep detection. | [voice/lib/enums/AdvancedMachineDetectionMode.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/AdvancedMachineDetectionMode.ts#L8) |
| <a id="detect"></a> `DETECT` | `"detect"` | Detect mode, used for advanced sync machine detection without beep detection. | [voice/lib/enums/AdvancedMachineDetectionMode.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/AdvancedMachineDetectionMode.ts#L13) |
| <a id="detectbeep"></a> `DETECTBEEP` | `"detect_beep"` | Detect beep mode, used for advanced sync machine detection with beep detection. | [voice/lib/enums/AdvancedMachineDetectionMode.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/AdvancedMachineDetectionMode.ts#L18) |

***

### CallDirection

Defined in: [voice/lib/enums/CallDirection.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallDirection.ts#L4)

Enum representing the direction of a call, whether it is outbound or inbound.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="inbound"></a> `INBOUND` | `"inbound"` | Inbound call direction. | [voice/lib/enums/CallDirection.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallDirection.ts#L13) |
| <a id="outbound"></a> `OUTBOUND` | `"outbound"` | Outbound call direction. | [voice/lib/enums/CallDirection.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallDirection.ts#L8) |

***

### CallStatus

Defined in: [voice/lib/enums/CallStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L4)

Enum representing the status of a call, including its various stages and outcomes.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="answered"></a> `ANSWERED` | `"answered"` | The call has been answered. | [voice/lib/enums/CallStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L18) |
| <a id="busy"></a> `BUSY` | `"busy"` | The call is busy. | [voice/lib/enums/CallStatus.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L33) |
| <a id="cancelled"></a> `CANCELLED` | `"cancelled"` | The call has been cancelled. | [voice/lib/enums/CallStatus.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L38) |
| <a id="completed"></a> `COMPLETED` | `"completed"` | The call has been completed. | [voice/lib/enums/CallStatus.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L28) |
| <a id="failed"></a> `FAILED` | `"failed"` | The call has failed. | [voice/lib/enums/CallStatus.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L43) |
| <a id="machine"></a> `MACHINE` | `"machine"` | The call has been detected as a machine. | [voice/lib/enums/CallStatus.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L23) |
| <a id="rejected"></a> `REJECTED` | `"rejected"` | The call has been rejected. | [voice/lib/enums/CallStatus.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L48) |
| <a id="ringing"></a> `RINGING` | `"ringing"` | The call is ringing. | [voice/lib/enums/CallStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L13) |
| <a id="started"></a> `STARTED` | `"started"` | The call has started. | [voice/lib/enums/CallStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L8) |
| <a id="timeout"></a> `TIMEOUT` | `"timeout"` | The call has timed out. | [voice/lib/enums/CallStatus.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L53) |
| <a id="unanswered"></a> `UNANSWERED` | `"unanswered"` | The call went unanswered. | [voice/lib/enums/CallStatus.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/CallStatus.ts#L58) |

***

### ConnectEventType

Defined in: [voice/lib/enums/NCCO/ConnectEventType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/ConnectEventType.ts#L4)

Enum representing different event types for the Connect NCCO action.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="synchronous"></a> `SYNCHRONOUS` | `"synchronous"` | Synchronous event type. | [voice/lib/enums/NCCO/ConnectEventType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/ConnectEventType.ts#L8) |

***

### HttpMethod

Defined in: [voice/lib/enums/HttpMethod.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/HttpMethod.ts#L4)

Enum representing HTTP methods used for making web requests.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="get"></a> `GET` | `"GET"` | The HTTP GET method, used for retrieving data from a server. | [voice/lib/enums/HttpMethod.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/HttpMethod.ts#L8) |
| <a id="post"></a> `POST` | `"POST"` | The HTTP POST method, used for sending data to a server to create or update resources. | [voice/lib/enums/HttpMethod.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/HttpMethod.ts#L13) |

***

### MachineDetection

Defined in: [voice/lib/enums/NCCO/MachineDetection.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/MachineDetection.ts#L4)

Enum representing machine detection behavior for the Connect NCCO action.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="continue"></a> `CONTINUE` | `"continue"` | Continue with the call if machine detection is triggered. | [voice/lib/enums/NCCO/MachineDetection.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/MachineDetection.ts#L8) |
| <a id="hangup"></a> `HANGUP` | `"hangup"` | Hang up the call if machine detection is triggered. | [voice/lib/enums/NCCO/MachineDetection.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/MachineDetection.ts#L13) |

***

### MachineDetectionBehavior

Defined in: [voice/lib/enums/MachineDetctionBehavior.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/MachineDetctionBehavior.ts#L4)

Enum representing the behavior of machine detection in a call.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="continue-1"></a> `CONTINUE` | `"continue"` | Continue the call even if a machine is detected. | [voice/lib/enums/MachineDetctionBehavior.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/MachineDetctionBehavior.ts#L8) |
| <a id="hangup-1"></a> `HANGUP` | `"hangup"` | Hang up the call if a machine is detected. | [voice/lib/enums/MachineDetctionBehavior.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/MachineDetctionBehavior.ts#L13) |

***

### NCCOActions

Defined in: [voice/lib/enums/NCCOActions.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L4)

Enum representing the available actions in a Nexmo Call Control Object (NCCO).

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="connect"></a> `CONNECT` | `"connect"` | Connect the call to an endpoint or multiple endpoints. | [voice/lib/enums/NCCOActions.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L8) |
| <a id="conversation"></a> `CONVERSATION` | `"conversation"` | Start a conversation that can include multiple participants. | [voice/lib/enums/NCCOActions.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L13) |
| <a id="input"></a> `INPUT` | `"input"` | Collect input from the caller, including DTMF tones or speech. | [voice/lib/enums/NCCOActions.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L18) |
| <a id="notify"></a> `NOTIFY` | `"notify"` | Send a notification or message to a specified endpoint. | [voice/lib/enums/NCCOActions.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L23) |
| <a id="record"></a> `RECORD` | `"record"` | Record the audio of a call. | [voice/lib/enums/NCCOActions.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L28) |
| <a id="stream"></a> `STREAM` | `"stream"` | Stream audio to a call. | [voice/lib/enums/NCCOActions.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L33) |
| <a id="talk"></a> `TALK` | `"talk"` | Play a text-to-speech message to the caller. | [voice/lib/enums/NCCOActions.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCOActions.ts#L38) |

***

### RecordingFormat

Defined in: [voice/lib/enums/NCCO/RecordingFormat.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/RecordingFormat.ts#L4)

Enum representing different recording formats for the Record NCCO action.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="mp3"></a> `MP3` | `"mp3"` | MP3 audio format. | [voice/lib/enums/NCCO/RecordingFormat.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/RecordingFormat.ts#L8) |
| <a id="ogg"></a> `OGG` | `"ogg"` | OGG audio format. | [voice/lib/enums/NCCO/RecordingFormat.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/RecordingFormat.ts#L18) |
| <a id="wav"></a> `WAV` | `"wav"` | WAV audio format. | [voice/lib/enums/NCCO/RecordingFormat.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/NCCO/RecordingFormat.ts#L13) |

***

### TTSLanguages

Defined in: [voice/lib/enums/TTSLanguages.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L4)

Enum representing the supported Text-to-Speech (TTS) languages for Nexmo's voice calls.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="af_za"></a> `AF_ZA` | `"af-ZA"` | Afrikaans (af-ZA) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L8) |
| <a id="ar"></a> `AR` | `"ar"` | Arabic (ar) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L13) |
| <a id="bg_bg"></a> `BG_BG` | `"bg-BG"` | Bulgarian (bg-BG) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L18) |
| <a id="bn_in"></a> `BN_IN` | `"bn-IN"` | Bengali (bn-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L23) |
| <a id="ca_es"></a> `CA_ES` | `"ca-ES"` | Catalan, Valencian (ca-ES) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L28) |
| <a id="cmn_cn"></a> `CMN_CN` | `"cmn-CN"` | China Chinese, Mandarin (cmn-CN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L33) |
| <a id="cmn_tw"></a> `CMN_TW` | `"cmn-TW"` | Taiwan Chinese, Mandarin (cmn-TW) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L38) |
| <a id="cs_cz"></a> `CS_CZ` | `"cs-CZ"` | Czech (cs-CZ) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L43) |
| <a id="cy_gb"></a> `CY_GB` | `"cy-GB"` | Welsh (cy-GB) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L48) |
| <a id="da_dk"></a> `DA_DK` | `"da-DK"` | Danish (da-DK) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L53) |
| <a id="de_at"></a> `DE_AT` | `"de-AT"` | Austria German (de-AT) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L58) |
| <a id="de_de"></a> `DE_DE` | `"de-DE"` | German (de-DE) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L63) |
| <a id="de_et"></a> `DE_ET` | `"de-ET"` | Ethiopia German (de-ET) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L68) |
| <a id="el_gr"></a> `EL_GR` | `"el-GR"` | Greek (el-GR) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L73) |
| <a id="en_au"></a> `EN_AU` | `"en-AU"` | Australia English (en-AU) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L78) |
| <a id="en_gb"></a> `EN_GB` | `"en-GB"` | United Kingdom English (en-GB) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L83) |
| <a id="en_gb_sct"></a> `EN_GB_SCT` | `"en-GB-SCT"` | Scotland English (en-GB-SCT) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:88](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L88) |
| <a id="en_gb_wls"></a> `EN_GB_WLS` | `"en-GB-WLS"` | Wales English (en-GB-WLS) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:93](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L93) |
| <a id="en_ie"></a> `EN_IE` | `"en-IE"` | Ireland English (en-IE) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:98](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L98) |
| <a id="en_in"></a> `EN_IN` | `"en-IN"` | India English (en-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L103) |
| <a id="en_nz"></a> `EN_NZ` | `"en-NZ"` | New Zealand English (en-NZ) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L108) |
| <a id="en_us"></a> `EN_US` | `"en-US"` | United States English (en-US) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:113](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L113) |
| <a id="en_za"></a> `EN_ZA` | `"en-ZA"` | South Africa English (en-ZA) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:118](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L118) |
| <a id="es_co"></a> `ES_CO` | `"es-CO"` | Colombia Spanish (es-CO) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:123](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L123) |
| <a id="es_es"></a> `ES_ES` | `"es-ES"` | Spain Spanish (es-ES) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:128](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L128) |
| <a id="es_mx"></a> `ES_MX` | `"es-MX"` | Mexico Spanish (es-MX) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:133](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L133) |
| <a id="es_us"></a> `ES_US` | `"es-US"` | United States Spanish (es-US) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:138](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L138) |
| <a id="eu_es"></a> `EU_ES` | `"eu-ES"` | Basque (eu-ES) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:143](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L143) |
| <a id="fi_fi"></a> `FI_FI` | `"fi-FI"` | Finnish (fi-FI) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:148](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L148) |
| <a id="fil_ph"></a> `FIL_PH` | `"fil-PH"` | Filipino (fil-PH) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:153](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L153) |
| <a id="fr_ca"></a> `FR_CA` | `"fr-CA"` | Canada French (fr-CA) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:158](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L158) |
| <a id="fr_fr"></a> `FR_FR` | `"fr-FR"` | France French (fr-FR) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:163](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L163) |
| <a id="gl_es"></a> `GL_ES` | `"gl-ES"` | Spain Galician (gl-ES) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:168](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L168) |
| <a id="gu_in"></a> `GU_IN` | `"gu-IN"` | Gujarati (gu-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:173](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L173) |
| <a id="he_il"></a> `HE_IL` | `"he-IL"` | Hebrew (he-IL) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:178](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L178) |
| <a id="hi_in"></a> `HI_IN` | `"hi-IN"` | Hindi (hi-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:183](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L183) |
| <a id="hu_hu"></a> `HU_HU` | `"hu-HU"` | Hungarian (hu-HU) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:188](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L188) |
| <a id="id_id"></a> `ID_ID` | `"id-ID"` | Indonesian (id-ID) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:193](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L193) |
| <a id="is_is"></a> `IS_IS` | `"is-IS"` | Icelandic (is-IS) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:198](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L198) |
| <a id="it_it"></a> `IT_IT` | `"it-IT"` | Italian (it-IT) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:203](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L203) |
| <a id="ja_jp"></a> `JA_JP` | `"ja-JP"` | Japanese (ja-JP) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:208](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L208) |
| <a id="kn_in"></a> `KN_IN` | `"kn-IN"` | Kannada (kn-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:213](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L213) |
| <a id="ko_kr"></a> `KO_KR` | `"ko-KR"` | Korean (ko-KR) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:218](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L218) |
| <a id="lv_lv"></a> `LV_LV` | `"lv-LV"` | Latvian (lv-LV) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:223](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L223) |
| <a id="ml_in"></a> `ML_IN` | `"ml-IN"` | Malayalam (ml-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:228](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L228) |
| <a id="ms_my"></a> `MS_MY` | `"ms-MY"` | Malay (ms-MY) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:233](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L233) |
| <a id="nb_no"></a> `NB_NO` | `"nb-NO"` | Norwegian (nb-NO) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:238](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L238) |
| <a id="nl_be"></a> `NL_BE` | `"nl-BE"` | Belgium Dutch (nl-BE) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:243](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L243) |
| <a id="nl_nl"></a> `NL_NL` | `"nl-NL"` | Netherlands Dutch (nl-NL) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:248](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L248) |
| <a id="no_no"></a> `NO_NO` | `"no-NO"` | Norwegian (no-NO) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:253](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L253) |
| <a id="pa_in"></a> `PA_IN` | `"pa-IN"` | Punjabi (pa-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:258](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L258) |
| <a id="pl_pl"></a> `PL_PL` | `"pl-PL"` | Polish (pl-PL) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:263](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L263) |
| <a id="pt_br"></a> `PT_BR` | `"pt-BR"` | Brazil Portuguese (pt-BR) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:268](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L268) |
| <a id="pt_pt"></a> `PT_PT` | `"pt-PT"` | Portugal Portuguese (pt-PT) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:273](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L273) |
| <a id="ro_ro"></a> `RO_RO` | `"ro-RO"` | Romanian (ro-RO) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:278](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L278) |
| <a id="ru_ru"></a> `RU_RU` | `"ru-RU"` | Russian (ru-RU) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:283](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L283) |
| <a id="sk_sk"></a> `SK_SK` | `"sk-SK"` | Slovak (sk-SK) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:288](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L288) |
| <a id="sr_rs"></a> `SR_RS` | `"sr-RS"` | Serbian (sr-RS) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:293](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L293) |
| <a id="sv_se"></a> `SV_SE` | `"sv-SE"` | Swedish (sv-SE) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:298](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L298) |
| <a id="ta_in"></a> `TA_IN` | `"ta-IN"` | Tamil (ta-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:303](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L303) |
| <a id="te_in"></a> `TE_IN` | `"te-IN"` | Telugu (te-IN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:308](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L308) |
| <a id="th_th"></a> `TH_TH` | `"th-TH"` | Thai (th-TH) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:313](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L313) |
| <a id="tr_tr"></a> `TR_TR` | `"tr-TR"` | Turkish (tr-TR) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:318](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L318) |
| <a id="uk_ua"></a> `UK_UA` | `"uk-UA"` | Ukrainian (uk-UA) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:323](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L323) |
| <a id="vi_vn"></a> `VI_VN` | `"vi-VN"` | Vietnamese (vi-VN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:328](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L328) |
| <a id="yue_cn"></a> `YUE_CN` | `"yue-CN"` | China Chinese, Cantonese (yue-CN) - Supported Text-to-Speech (TTS) language. | [voice/lib/enums/TTSLanguages.ts:333](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSLanguages.ts#L333) |

***

### TTSVoices

Defined in: [voice/lib/enums/TTSVoices.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L4)

Enum representing supported Text-to-Speech (TTS) voices.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="aditi"></a> `ADITI` | `"Aditi"` | Aditi - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L8) |
| <a id="agnieszka"></a> `AGNIESZKA` | `"Agnieszka"` | Agnieszka - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L13) |
| <a id="alva"></a> `ALVA` | `"Alva"` | Alva - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L18) |
| <a id="amy"></a> `AMY` | `"Amy"` | Amy - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L23) |
| <a id="astrid"></a> `ASTRID` | `"Astrid"` | Astrid - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L28) |
| <a id="bianca"></a> `BIANCA` | `"Bianca"` | Bianca - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L33) |
| <a id="brian"></a> `BRIAN` | `"Brian"` | Brian - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L38) |
| <a id="carla"></a> `CARLA` | `"Carla"` | Carla - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L43) |
| <a id="carmen"></a> `CARMEN` | `"Carmen"` | Carmen - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L48) |
| <a id="carmit"></a> `CARMIT` | `"Carmit"` | Carmit - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L53) |
| <a id="catarina"></a> `CATARINA` | `"Catarina"` | Catarina - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L58) |
| <a id="celine"></a> `CELINE` | `"Celine"` | Celine - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L63) |
| <a id="cem"></a> `CEM` | `"Cem"` | Cem - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L68) |
| <a id="chantal"></a> `CHANTAL` | `"Chantal"` | Chantal - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L73) |
| <a id="chipmunk"></a> `CHIPMUNK` | `"Chipmunk"` | Chipmunk - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L78) |
| <a id="conchita"></a> `CONCHITA` | `"Conchita"` | Conchita - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L83) |
| <a id="cristiano"></a> `CRISTIANO` | `"Cristiano"` | Cristiano - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:88](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L88) |
| <a id="damayanti"></a> `DAMAYANTI` | `"Damayanti"` | Damayanti - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:93](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L93) |
| <a id="dora"></a> `DORA` | `"Dora"` | Dora - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:98](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L98) |
| <a id="emma"></a> `EMMA` | `"Emma"` | Emma - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L103) |
| <a id="empar"></a> `EMPAR` | `"Empar"` | Empar - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L108) |
| <a id="enrique"></a> `ENRIQUE` | `"Enrique"` | Enrique - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:113](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L113) |
| <a id="eric"></a> `ERIC` | `"Eric"` | Eric - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:118](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L118) |
| <a id="ewa"></a> `EWA` | `"Ewa"` | Ewa - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:123](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L123) |
| <a id="felipe"></a> `FELIPE` | `"Felipe"` | Felipe - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:128](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L128) |
| <a id="filiz"></a> `FILIZ` | `"Filiz"` | Filiz - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:133](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L133) |
| <a id="geraint"></a> `GERAINT` | `"Geraint"` | Geraint - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:138](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L138) |
| <a id="giorgio"></a> `GIORGIO` | `"Giorgio"` | Giorgio - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:143](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L143) |
| <a id="gwyneth"></a> `GWYNETH` | `"Gwyneth"` | Gwyneth - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:148](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L148) |
| <a id="hans"></a> `HANS` | `"Hans"` | Hans - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:153](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L153) |
| <a id="henrik"></a> `HENRIK` | `"Henrik"` | Henrik - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:158](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L158) |
| <a id="ines"></a> `INES` | `"Ines"` | Ines - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:163](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L163) |
| <a id="ioana"></a> `IOANA` | `"Ioana"` | Ioana - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:168](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L168) |
| <a id="iveta"></a> `IVETA` | `"Iveta"` | Iveta - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:173](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L173) |
| <a id="ivy"></a> `IVY` | `"Ivy"` | Ivy - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:178](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L178) |
| <a id="jacek"></a> `JACEK` | `"Jacek"` | Jacek - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:183](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L183) |
| <a id="jan"></a> `JAN` | `"Jan"` | Jan - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:188](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L188) |
| <a id="jennifer"></a> `JENNIFER` | `"Jennifer"` | Jennifer - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:193](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L193) |
| <a id="joana"></a> `JOANA` | `"Joana"` | Joana - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:198](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L198) |
| <a id="joanna"></a> `JOANNA` | `"Joanna"` | Joanna - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:203](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L203) |
| <a id="joey"></a> `JOEY` | `"Joey"` | Joey - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:208](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L208) |
| <a id="jordi"></a> `JORDI` | `"Jordi"` | Jordi - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:213](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L213) |
| <a id="justin"></a> `JUSTIN` | `"Justin"` | Justin - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:218](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L218) |
| <a id="kanya"></a> `KANYA` | `"Kanya"` | Kanya - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:223](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L223) |
| <a id="karl"></a> `KARL` | `"Karl"` | Karl - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:228](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L228) |
| <a id="kendra"></a> `KENDRA` | `"Kendra"` | Kendra - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:233](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L233) |
| <a id="kimberly"></a> `KIMBERLY` | `"Kimberly"` | Kimberly - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:238](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L238) |
| <a id="laila"></a> `LAILA` | `"Laila"` | Laila - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:243](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L243) |
| <a id="laura"></a> `LAURA` | `"Laura"` | Laura - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:248](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L248) |
| <a id="lea"></a> `LEA` | `"Lea"` | Lea - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:253](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L253) |
| <a id="lekha"></a> `LEKHA` | `"Lekha"` | Lekha - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:258](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L258) |
| <a id="liv"></a> `LIV` | `"Liv"` | Liv - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:263](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L263) |
| <a id="lotte"></a> `LOTTE` | `"Lotte"` | Lotte - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:268](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L268) |
| <a id="lucia"></a> `LUCIA` | `"Lucia"` | Lucia - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:273](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L273) |
| <a id="luciana"></a> `LUCIANA` | `"Luciana"` | Luciana - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:278](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L278) |
| <a id="mads"></a> `MADS` | `"Mads"` | Mads - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:283](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L283) |
| <a id="maged"></a> `MAGED` | `"Maged"` | Maged - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:288](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L288) |
| <a id="maja"></a> `MAJA` | `"Maja"` | Maja - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:293](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L293) |
| <a id="mariska"></a> `MARISKA` | `"Mariska"` | Mariska - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:298](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L298) |
| <a id="marlene"></a> `MARLENE` | `"Marlene"` | Marlene - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:303](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L303) |
| <a id="mathieu"></a> `MATHIEU` | `"Mathieu"` | Mathieu - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:308](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L308) |
| <a id="matthew"></a> `MATTHEW` | `"Matthew"` | Matthew - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:313](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L313) |
| <a id="maxim"></a> `MAXIM` | `"Maxim"` | Maxim - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:318](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L318) |
| <a id="mei_jia"></a> `MEI_JIA` | `"Mei-Jia"` | Mei-Jia - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:323](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L323) |
| <a id="melina"></a> `MELINA` | `"Melina"` | Melina - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:328](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L328) |
| <a id="mia"></a> `MIA` | `"Mia"` | Mia - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:333](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L333) |
| <a id="miguel"></a> `MIGUEL` | `"Miguel"` | Miguel - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:338](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L338) |
| <a id="miren"></a> `MIREN` | `"Miren"` | Miren - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:343](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L343) |
| <a id="mizuki"></a> `MIZUKI` | `"Mizuki"` | Mizuki - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:348](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L348) |
| <a id="montserrat"></a> `MONTSERRAT` | `"Montserrat"` | Montserrat - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:353](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L353) |
| <a id="naja"></a> `NAJA` | `"Naja"` | Naja - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:358](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L358) |
| <a id="nicole"></a> `NICOLE` | `"Nicole"` | Nicole - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:363](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L363) |
| <a id="nikos"></a> `NIKOS` | `"Nikos"` | Nikos - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:368](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L368) |
| <a id="nora"></a> `NORA` | `"Nora"` | Nora - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:373](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L373) |
| <a id="oskar"></a> `OSKAR` | `"Oskar"` | Oskar - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:378](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L378) |
| <a id="penelope"></a> `PENELOPE` | `"Penelope"` | Penelope - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:383](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L383) |
| <a id="raveena"></a> `RAVEENA` | `"Raveena"` | Raveena - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:388](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L388) |
| <a id="ricardo"></a> `RICARDO` | `"Ricardo"` | Ricardo - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:393](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L393) |
| <a id="ruben"></a> `RUBEN` | `"Ruben"` | Ruben - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:398](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L398) |
| <a id="russell"></a> `RUSSELL` | `"Russell"` | Russell - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:403](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L403) |
| <a id="salli"></a> `SALLI` | `"Salli"` | Salli - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:408](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L408) |
| <a id="satu"></a> `SATU` | `"Satu"` | Satu - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:413](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L413) |
| <a id="seoyeon"></a> `SEOYEON` | `"Seoyeon"` | Seoyeon - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:418](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L418) |
| <a id="sin_ji"></a> `SIN_JI` | `"Sin-Ji"` | Sin-Ji - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:423](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L423) |
| <a id="sora"></a> `SORA` | `"Sora"` | Sora - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:428](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L428) |
| <a id="takumi"></a> `TAKUMI` | `"Takumi"` | Takumi - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:433](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L433) |
| <a id="tarik"></a> `TARIK` | `"Tarik"` | Tarik - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:438](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L438) |
| <a id="tatyana"></a> `TATYANA` | `"Tatyana"` | Tatyana - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:443](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L443) |
| <a id="tessa"></a> `TESSA` | `"Tessa"` | Tessa - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:448](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L448) |
| <a id="tian_tian"></a> `TIAN_TIAN` | `"Tian-Tian"` | Tian-Tian - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:453](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L453) |
| <a id="vicki"></a> `VICKI` | `"Vicki"` | Vicki - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:458](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L458) |
| <a id="vitoria"></a> `VITORIA` | `"Vitoria"` | Vitoria - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:463](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L463) |
| <a id="yelda"></a> `YELDA` | `"Yelda"` | Yelda - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:468](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L468) |
| <a id="zeina"></a> `ZEINA` | `"Zeina"` | Zeina - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:473](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L473) |
| <a id="zhiyu"></a> `ZHIYU` | `"Zhiyu"` | Zhiyu - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:478](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L478) |
| <a id="zuzana"></a> `ZUZANA` | `"Zuzana"` | Zuzana - Supported Text-to-Speech (TTS) voice. | [voice/lib/enums/TTSVoices.ts:483](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/TTSVoices.ts#L483) |

***

### WebsocketBitrate

Defined in: [voice/lib/enums/Endpoint/WebsocketBitrate.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/Endpoint/WebsocketBitrate.ts#L4)

Enum representing different bitrate options for audio in a WebSocket configuration.

#### Enumeration Members

| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="rate_16000"></a> `RATE_16000` | `"audio/l16;rate=16000"` | Audio bitrate at 16000 samples per second. | [voice/lib/enums/Endpoint/WebsocketBitrate.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/Endpoint/WebsocketBitrate.ts#L13) |
| <a id="rate_8000"></a> `RATE_8000` | `"audio/l16;rate=8000"` | Audio bitrate at 8000 samples per second. | [voice/lib/enums/Endpoint/WebsocketBitrate.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/enums/Endpoint/WebsocketBitrate.ts#L8) |

## Classes

### Connect

Defined in: [voice/lib/classes/NCCO/Connect.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L11)

Represents a Connect action in the Nexmo Call Control Object (NCCO) for making voice calls.

#### Implements

- `ConnectAction`
- `Serializable`

#### Constructors

##### Constructor

```ts
new Connect(
   endpoint, 
   from?, 
   randomFromNumber?, 
   eventType?, 
   timeout?, 
   limit?, 
   machineDetection?, 
   eventUrl?, 
   eventMethod?, 
   ringbackTone?): Connect;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:104](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L104)

Create a new Connect instance.

###### Parameters

###### endpoint

[`CallEndpoint`](#callendpoint)

An array of CallEndpoint objects representing the endpoints to connect to in the call.

###### from?

`string`

The caller's phone number to display as the caller ID.

###### randomFromNumber?

`boolean`

Set to true to use a random phone number as the caller ID.

###### eventType?

[`SYNCHRONOUS`](#synchronous)

The event type for call progress events.

###### timeout?

`number`

The timeout value in seconds.

###### limit?

`number`

The maximum number of concurrent calls.

###### machineDetection?

[`MachineDetection`](#machinedetection)

The behavior when voicemail is detected.

###### eventUrl?

`string`

An array of event URLs.

###### eventMethod?

`string`

The HTTP method used for event callbacks.

###### ringbackTone?

`string`

The URL of the ringback tone audio file.

###### Returns

[`Connect`](#connect-1)

#### Properties

##### action

```ts
action: CONNECT = NCCOActions.CONNECT;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L15)

The action type, which is always 'connect'.

###### Implementation of

```ts
ConnectAction.action
```

##### endpoint

```ts
endpoint: CallEndpoint[];
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L23)

An array of CallEndpoint objects representing the endpoints to connect to in the call.

###### Param

An array of CallEndpoint objects
representing the endpoints to connect to in the call.

###### Implementation of

```ts
ConnectAction.endpoint
```

##### eventMethod?

```ts
optional eventMethod: string;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:80](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L80)

The HTTP method used to send event information to the event URL(s).

###### Param

The HTTP method used for event callbacks.

###### Implementation of

```ts
ConnectAction.eventMethod
```

##### eventType?

```ts
optional eventType: SYNCHRONOUS;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L45)

The event type for call progress events sent to the specified event URL.

###### Param

The event type for call progress events.

###### Implementation of

```ts
ConnectAction.eventType
```

##### eventUrl?

```ts
optional eventUrl: string[];
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L73)

An array of event URLs where call progress events are sent to. Multiple URLs can be specified.

###### Param

An array of event URLs.

###### Implementation of

```ts
ConnectAction.eventUrl
```

##### from?

```ts
optional from: string;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L30)

The caller's phone number to display as the caller ID.

###### Param

The caller's phone number to display as the caller ID.

###### Implementation of

```ts
ConnectAction.from
```

##### limit?

```ts
optional limit: number;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L59)

The maximum number of concurrent calls that can be handled by your application.

###### Param

The maximum number of concurrent calls.

###### Implementation of

```ts
ConnectAction.limit
```

##### machineDetection?

```ts
optional machineDetection: MachineDetection;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:66](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L66)

Configure the behavior when Vonage detects that the call is answered by voicemail.

###### Param

The behavior when voicemail is detected.

###### Implementation of

```ts
ConnectAction.machineDetection
```

##### randomFromNumber?

```ts
optional randomFromNumber: boolean;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L38)

Set to true to use a random phone number as the caller ID from the list of
numbers assigned to the current application.

###### Param

Set to true to use a random phone number as the caller ID.

###### Implementation of

```ts
ConnectAction.randomFromNumber
```

##### ringbackTone?

```ts
optional ringbackTone: string;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:87](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L87)

The URL of a ringback tone to play to the caller while waiting for the call to be answered.

###### Param

The URL of the ringback tone audio file.

###### Implementation of

```ts
ConnectAction.ringbackTone
```

##### timeout?

```ts
optional timeout: number;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L52)

The time in seconds that Vonage waits for the call to be answered before timing out.

###### Param

The timeout value in seconds.

###### Implementation of

```ts
ConnectAction.timeout
```

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): ConnectAction;
```

Defined in: [voice/lib/classes/NCCO/Connect.ts:152](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Connect.ts#L152)

Serialize the Connect action to a Nexmo Call Control Object (NCCO) format.

###### Returns

`ConnectAction`

- The serialized Connect action.

###### Implementation of

```ts
Serializable.serializeToNCCO
```

***

### Conversation

Defined in: [voice/lib/classes/NCCO/Conversation.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L8)

Represents a Conversation action in the Nexmo Call Control Object (NCCO) for managing audio conferences.

#### Implements

- `ConversationAction`
- `Serializable`

#### Constructors

##### Constructor

```ts
new Conversation(
   name, 
   musicOnHoldUrl?, 
   startOnEnter?, 
   endOnExit?, 
   record?, 
   canSpeak?, 
   canHear?, 
   mute?): Conversation;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:82](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L82)

Create a new Conversation instance.

###### Parameters

###### name

`string`

The name of the conversation.

###### musicOnHoldUrl?

`string`

An array of music on hold URLs.

###### startOnEnter?

`boolean`

Set to true to start the conversation on participant enter.

###### endOnExit?

`boolean`

Set to true to end the conversation on last participant exit.

###### record?

`boolean`

Set to true to record the conversation.

###### canSpeak?

`string`[]

An array of participant IDs who can speak in the conversation.

###### canHear?

`string`[]

An array of participant IDs who can hear in the conversation.

###### mute?

`boolean`

Set to true to mute all participants in the conversation.

###### Returns

[`Conversation`](#conversation-1)

#### Properties

##### action

```ts
action: CONVERSATION = NCCOActions.CONVERSATION;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L12)

The action type, which is always 'conversation'.

###### Implementation of

```ts
ConversationAction.action
```

##### canHear?

```ts
optional canHear: string[];
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:61](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L61)

An array of participant IDs (e.g., phone numbers) who can hear in the conversation.

###### Param

An array of participant IDs who can hear in the conversation.

###### Implementation of

```ts
ConversationAction.canHear
```

##### canSpeak?

```ts
optional canSpeak: string[];
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L54)

An array of participant IDs (e.g., phone numbers) who can speak in the conversation.

###### Param

An array of participant IDs who can speak in the conversation.

###### Implementation of

```ts
ConversationAction.canSpeak
```

##### endOnExit?

```ts
optional endOnExit: boolean;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L40)

Set to true to end the conversation when the last participant exits.

###### Param

Set to true to end the conversation on last participant exit.

###### Implementation of

```ts
ConversationAction.endOnExit
```

##### musicOnHoldUrl?

```ts
optional musicOnHoldUrl: string[];
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L26)

An array of URLs for music to be played while participants are on hold.

###### Param

An array of music on hold URLs.

###### Implementation of

```ts
ConversationAction.musicOnHoldUrl
```

##### mute?

```ts
optional mute: boolean;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L68)

Set to true to mute all participants in the conversation.

###### Param

Set to true to mute all participants in the conversation.

###### Implementation of

```ts
ConversationAction.mute
```

##### name

```ts
name: string;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L19)

The name of the conversation.

###### Param

The name of the conversation.

###### Implementation of

```ts
ConversationAction.name
```

##### record?

```ts
optional record: boolean;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L47)

Set to true to record the conversation.

###### Param

Set to true to record the conversation.

###### Implementation of

```ts
ConversationAction.record
```

##### startOnEnter?

```ts
optional startOnEnter: boolean;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L33)

Set to true to start the conversation when a participant enters.

###### Param

Set to true to start the conversation on participant enter.

###### Implementation of

```ts
ConversationAction.startOnEnter
```

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): ConversationAction;
```

Defined in: [voice/lib/classes/NCCO/Conversation.ts:122](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Conversation.ts#L122)

Serialize the Conversation action to a Nexmo Call Control Object (NCCO) format.

###### Returns

`ConversationAction`

- The serialized Conversation action.

###### Implementation of

```ts
Serializable.serializeToNCCO
```

***

### Input

Defined in: [voice/lib/classes/NCCO/Input.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L10)

Represents an Input action in the Nexmo Call Control Object (NCCO) for gathering user input.

#### Implements

- `Pick`\<`InputAction`, 
  \| `"action"`
  \| `"type"`
  \| `"dtmf"`
  \| `"speech"`
  \| `"eventUrl"`
  \| `"eventMethod"`
  \| `"mode"`\>
- `Serializable`

#### Constructors

##### Constructor

```ts
new Input(
   dtmf?, 
   speech?, 
   eventUrl?, 
   eventMethod?, 
   mode?): Input;
```

Defined in: [voice/lib/classes/NCCO/Input.ts:59](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L59)

Create a new Input instance.

###### Parameters

###### dtmf?

`DTMFSettings`

DTMF input settings.

###### speech?

`SpeechSettings`

Speech input settings.

###### eventUrl?

`string`

URL to send events to asynchronously.

###### eventMethod?

`string`

The HTTP method used to send events.

###### mode?

`"synchronous"` | `"asynchronous"`

###### Returns

[`Input`](#input-1)

#### Properties

##### action

```ts
action: INPUT = NCCOActions.INPUT;
```

Defined in: [voice/lib/classes/NCCO/Input.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L14)

The action type, which is always 'input'.

###### Implementation of

```ts
Pick.action
```

##### dtmf?

```ts
optional dtmf: DTMFSettings;
```

Defined in: [voice/lib/classes/NCCO/Input.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L24)

DTMF input settings.

###### Implementation of

```ts
Pick.dtmf
```

##### eventMethod?

```ts
optional eventMethod: string;
```

Defined in: [voice/lib/classes/NCCO/Input.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L39)

The HTTP method used to send events (e.g., 'POST' or 'GET').

###### Implementation of

```ts
Pick.eventMethod
```

##### eventUrl?

```ts
optional eventUrl: string[] = [];
```

Defined in: [voice/lib/classes/NCCO/Input.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L34)

An array of URLs to send events to asynchronously.

###### Implementation of

```ts
Pick.eventUrl
```

##### mode?

```ts
optional mode: "synchronous" | "asynchronous";
```

Defined in: [voice/lib/classes/NCCO/Input.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L49)

Input processing mode, currently only applicable to DTMF. Valid values are
synchronous (the default) and asynchronous. If set to asynchronous, all
DTMF settings must be left blank. In asynchronous mode, digits are sent one
at a time to the event webhook in real time. In the default synchronous
mode, this is controlled by the DTMF settings instead and the inputs are
sent in batch.

###### Implementation of

```ts
Pick.mode
```

##### speech?

```ts
optional speech: SpeechSettings;
```

Defined in: [voice/lib/classes/NCCO/Input.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L29)

Speech input settings.

###### Implementation of

```ts
Pick.speech
```

##### type

```ts
type: string[] = [];
```

Defined in: [voice/lib/classes/NCCO/Input.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L19)

An array of input types ('dtmf' and/or 'speech').

###### Implementation of

```ts
Pick.type
```

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): InputAction;
```

Defined in: [voice/lib/classes/NCCO/Input.ts:100](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Input.ts#L100)

Serialize the Input action to a Nexmo Call Control Object (NCCO) format.

###### Returns

`InputAction`

- The serialized Input action.

###### Implementation of

```ts
Serializable.serializeToNCCO
```

***

### NCCOBuilder

Defined in: [voice/lib/classes/NCCO/NCCOBuilder.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/NCCOBuilder.ts#L7)

A builder class for creating Nexmo Call Control Objects (NCCOs).

#### Constructors

##### Constructor

```ts
new NCCOBuilder(): NCCOBuilder;
```

###### Returns

[`NCCOBuilder`](#nccobuilder)

#### Properties

##### actions

```ts
protected actions: NCCOAction[] = [];
```

Defined in: [voice/lib/classes/NCCO/NCCOBuilder.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/NCCOBuilder.ts#L8)

#### Methods

##### addAction()

```ts
addAction(action): NCCOBuilder;
```

Defined in: [voice/lib/classes/NCCO/NCCOBuilder.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/NCCOBuilder.ts#L16)

Add an action to the NCCO builder.

###### Parameters

###### action

[`NCCOAction`](#nccoaction)

The action to add to the NCCO.

###### Returns

[`NCCOBuilder`](#nccobuilder)

- The NCCO builder instance (for method chaining).

##### build()

```ts
build(): NCCOAction[];
```

Defined in: [voice/lib/classes/NCCO/NCCOBuilder.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/NCCOBuilder.ts#L31)

Build the NCCO by serializing the added actions.

###### Returns

[`NCCOAction`](#nccoaction)[]

- The built NCCO, which is an array of actions.

***

### Notify

Defined in: [voice/lib/classes/NCCO/Notify.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L8)

Represents a Notify action in an NCCO.

#### Implements

- `NotifyAction`
- `Serializable`

#### Constructors

##### Constructor

```ts
new Notify(
   payload, 
   eventUrl, 
   eventMethod?): Notify;
```

Defined in: [voice/lib/classes/NCCO/Notify.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L23)

Creates a new Notify action.

###### Parameters

###### payload

The payload data to send with the notification.

###### eventUrl

`string`

The URL where the notification events will be sent.

###### eventMethod?

`string`

The HTTP method for sending notification events (e.g., "POST").

###### Returns

[`Notify`](#notify-1)

#### Properties

##### action

```ts
action: NOTIFY = NCCOActions.NOTIFY;
```

Defined in: [voice/lib/classes/NCCO/Notify.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L9)

The action type, which should be set to 'notify'.

###### Implementation of

```ts
NotifyAction.action
```

##### eventMethod?

```ts
optional eventMethod: string;
```

Defined in: [voice/lib/classes/NCCO/Notify.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L14)

(Optional) The HTTP method used for sending the notification to the event URLs. If not specified, the default
HTTP method is used.

###### Implementation of

```ts
NotifyAction.eventMethod
```

##### eventUrl

```ts
eventUrl: string[];
```

Defined in: [voice/lib/classes/NCCO/Notify.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L13)

An array of event URLs to which the notification will be sent.

###### Implementation of

```ts
NotifyAction.eventUrl
```

##### payload

```ts
payload: object;
```

Defined in: [voice/lib/classes/NCCO/Notify.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L10)

The payload to be sent as part of the notification. It is a key-value pair object where the keys and values
are both strings.

###### Index Signature

```ts
[key: string]: string
```

###### Implementation of

```ts
NotifyAction.payload
```

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): NotifyAction;
```

Defined in: [voice/lib/classes/NCCO/Notify.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Notify.ts#L41)

Serialize the Notify action to an NCCO-compatible format.

###### Returns

`NotifyAction`

- The serialized Notify action.

###### Implementation of

```ts
Serializable.serializeToNCCO
```

***

### ~~OutboundCallWithAnswerURL~~

Defined in: [voice/lib/classes/OutboundCallWithAnswerURL.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithAnswerURL.ts#L16)

Represents an outbound call with an answer URL.

#### Deprecated

This class is deprecated. Please update to use the CallWithAnswerURL type

#### Extends

- `OutboundCall`

#### Constructors

##### Constructor

```ts
new OutboundCallWithAnswerURL(
   answerUrl, 
   to, 
   from?): OutboundCallWithAnswerURL;
```

Defined in: [voice/lib/classes/OutboundCallWithAnswerURL.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithAnswerURL.ts#L39)

Creates a new outbound call with an answer URL.

###### Parameters

###### answerUrl

`string`

The answer URL for the call.

###### to

[`CallEndpoint`](#callendpoint)

The call endpoint to which the outbound call will be made.

###### from?

[`PhoneEndpoint`](#phoneendpoint)

The phone endpoint object representing the caller's information.

###### Returns

[`OutboundCallWithAnswerURL`](#outboundcallwithanswerurl)

###### Overrides

```ts
OutboundCall.constructor
```

#### Properties

##### ~~answer\_url~~

```ts
answer_url: string[];
```

Defined in: [voice/lib/classes/OutboundCallWithAnswerURL.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithAnswerURL.ts#L23)

The list of answer URLs.

##### ~~answerUrl~~

```ts
answerUrl: string[];
```

Defined in: [voice/lib/classes/OutboundCallWithAnswerURL.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithAnswerURL.ts#L30)

The list of answer URLs.

###### Deprecated

Use `answer_url` instead.

##### ~~eventMethod?~~

```ts
optional eventMethod: HttpMethod;
```

Defined in: [voice/lib/classes/OutboundCall.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L40)

The HTTP method to use for event notifications (optional).

###### Inherited from

```ts
OutboundCall.eventMethod
```

##### ~~eventUrl?~~

```ts
optional eventUrl: string[];
```

Defined in: [voice/lib/classes/OutboundCall.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L35)

The list of event URLs (optional).

###### Inherited from

```ts
OutboundCall.eventUrl
```

##### ~~from?~~

```ts
optional from: PhoneEndpoint;
```

Defined in: [voice/lib/classes/OutboundCall.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L25)

The phone endpoint object representing the caller's information.

###### Inherited from

```ts
OutboundCall.from
```

##### ~~lengthTimer?~~

```ts
optional lengthTimer: number;
```

Defined in: [voice/lib/classes/OutboundCall.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L50)

The length timer for the call (optional).

###### Inherited from

```ts
OutboundCall.lengthTimer
```

##### ~~machineDetection?~~

```ts
optional machineDetection: MachineDetectionBehavior;
```

Defined in: [voice/lib/classes/OutboundCall.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L45)

The machine detection behavior (optional).

###### Inherited from

```ts
OutboundCall.machineDetection
```

##### ~~randomFromNumber?~~

```ts
optional randomFromNumber: boolean;
```

Defined in: [voice/lib/classes/OutboundCall.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L30)

Indicates whether to use a random from number (optional).

###### Inherited from

```ts
OutboundCall.randomFromNumber
```

##### ~~ringingTimer?~~

```ts
optional ringingTimer: number;
```

Defined in: [voice/lib/classes/OutboundCall.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L55)

The ringing timer for the call (optional).

###### Inherited from

```ts
OutboundCall.ringingTimer
```

##### ~~to~~

```ts
to: CallEndpoint[];
```

Defined in: [voice/lib/classes/OutboundCall.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L20)

The list of call endpoints to which the outbound call will be made.

###### Inherited from

```ts
OutboundCall.to
```

***

### ~~OutboundCallWithNCCO~~

Defined in: [voice/lib/classes/OutboundCallWithNCCO.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithNCCO.ts#L16)

Represents an outbound call with NCCO (Nexmo Call Control Object).

#### Deprecated

This class is deprecated. Please update to use the CallWithNCCO type

#### Extends

- `OutboundCall`

#### Constructors

##### Constructor

```ts
new OutboundCallWithNCCO(
   ncco, 
   to, 
   from?): OutboundCallWithNCCO;
```

Defined in: [voice/lib/classes/OutboundCallWithNCCO.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithNCCO.ts#L31)

Creates a new outbound call with NCCO.

###### Parameters

###### ncco

[`NCCOAction`](#nccoaction)[]

The NCCO actions for the call.

###### to

[`CallEndpoint`](#callendpoint)

The call endpoint to which the outbound call will be made.

###### from?

[`PhoneEndpoint`](#phoneendpoint)

The phone endpoint object representing the caller's information.

###### Returns

[`OutboundCallWithNCCO`](#outboundcallwithncco)

###### Overrides

```ts
OutboundCall.constructor
```

#### Properties

##### ~~eventMethod?~~

```ts
optional eventMethod: HttpMethod;
```

Defined in: [voice/lib/classes/OutboundCall.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L40)

The HTTP method to use for event notifications (optional).

###### Inherited from

```ts
OutboundCall.eventMethod
```

##### ~~eventUrl?~~

```ts
optional eventUrl: string[];
```

Defined in: [voice/lib/classes/OutboundCall.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L35)

The list of event URLs (optional).

###### Inherited from

```ts
OutboundCall.eventUrl
```

##### ~~from?~~

```ts
optional from: PhoneEndpoint;
```

Defined in: [voice/lib/classes/OutboundCall.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L25)

The phone endpoint object representing the caller's information.

###### Inherited from

```ts
OutboundCall.from
```

##### ~~lengthTimer?~~

```ts
optional lengthTimer: number;
```

Defined in: [voice/lib/classes/OutboundCall.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L50)

The length timer for the call (optional).

###### Inherited from

```ts
OutboundCall.lengthTimer
```

##### ~~machineDetection?~~

```ts
optional machineDetection: MachineDetectionBehavior;
```

Defined in: [voice/lib/classes/OutboundCall.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L45)

The machine detection behavior (optional).

###### Inherited from

```ts
OutboundCall.machineDetection
```

##### ~~ncco~~

```ts
ncco: NCCOAction[];
```

Defined in: [voice/lib/classes/OutboundCallWithNCCO.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCallWithNCCO.ts#L22)

The list of NCCO actions.

##### ~~randomFromNumber?~~

```ts
optional randomFromNumber: boolean;
```

Defined in: [voice/lib/classes/OutboundCall.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L30)

Indicates whether to use a random from number (optional).

###### Inherited from

```ts
OutboundCall.randomFromNumber
```

##### ~~ringingTimer?~~

```ts
optional ringingTimer: number;
```

Defined in: [voice/lib/classes/OutboundCall.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L55)

The ringing timer for the call (optional).

###### Inherited from

```ts
OutboundCall.ringingTimer
```

##### ~~to~~

```ts
to: CallEndpoint[];
```

Defined in: [voice/lib/classes/OutboundCall.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/OutboundCall.ts#L20)

The list of call endpoints to which the outbound call will be made.

###### Inherited from

```ts
OutboundCall.to
```

***

### Record

Defined in: [voice/lib/classes/NCCO/Record.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L8)

Represents a Record action in an NCCO.

#### Implements

- `RecordAction`

#### Constructors

##### Constructor

```ts
new Record(
   format?, 
   split?, 
   channels?, 
   endOnSilence?, 
   endOnKey?, 
   timeout?, 
   beepStart?, 
   eventUrl?, 
   eventMethod?): Record;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:72](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L72)

Creates a new Record action.

###### Parameters

###### format?

[`RecordingFormat`](#recordingformat)

The recording format (e.g., "mp3", "wav").

###### split?

`string`

The split type for recording (should be "conversation").

###### channels?

`number`

The number of audio channels (1 to 32).

###### endOnSilence?

`number`

The duration of silence (in seconds) to end the recording (3 to 10 seconds).

###### endOnKey?

`string`

The DTMF key that ends the recording (e.g., "0", "*", "#").

###### timeout?

`number`

The maximum recording duration in seconds (3 to 7200 seconds).

###### beepStart?

`boolean`

Whether to play a beep before recording starts.

###### eventUrl?

`string`

The URL where recording events will be sent.

###### eventMethod?

`string`

The HTTP method for sending recording events (e.g., "POST").

###### Returns

[`Record`](#record-2)

#### Properties

##### action

```ts
action: RECORD = NCCOActions.RECORD;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L12)

The action type for the Record action.

###### Implementation of

```ts
RecordAction.action
```

##### beepStart?

```ts
optional beepStart: boolean;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L47)

Whether to play a beep before recording starts.

###### Implementation of

```ts
RecordAction.beepStart
```

##### eventMethod?

```ts
optional eventMethod: string;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:57](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L57)

The HTTP method for sending recording events (e.g., "POST").

###### Implementation of

```ts
RecordAction.eventMethod
```

##### eventUrl?

```ts
optional eventUrl: string[];
```

Defined in: [voice/lib/classes/NCCO/Record.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L52)

The URL where recording events will be sent.

###### Implementation of

```ts
RecordAction.eventUrl
```

##### format?

```ts
optional format: RecordingFormat;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L17)

The recording format (e.g., "mp3", "wav").

###### Implementation of

```ts
RecordAction.format
```

##### wrappedChannels?

```ts
protected optional wrappedChannels: number;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L27)

The number of audio channels (1 to 32).

##### wrappedEndOnKey?

```ts
protected optional wrappedEndOnKey: string;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L37)

The DTMF key that ends the recording (e.g., "0", "*", "#").

##### wrappedEndOnSilence?

```ts
protected optional wrappedEndOnSilence: number;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L32)

The duration of silence (in seconds) to end the recording (3 to 10 seconds).

##### wrappedSplit?

```ts
protected optional wrappedSplit: string;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L22)

The split type for recording (always "conversation").

##### wrappedTimeOut?

```ts
protected optional wrappedTimeOut: number;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L42)

The maximum recording duration in seconds (3 to 7200 seconds).

#### Accessors

##### channels

###### Get Signature

```ts
get channels(): undefined | number;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:117](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L117)

Getter for the number of audio channels.

###### Returns

`undefined` \| `number`

- The current number of audio channels.

###### Set Signature

```ts
set channels(channels): void;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:127](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L127)

Setter for the number of audio channels.

###### Throws

- If the channel value is invalid or split is not set to "conversation."

###### Parameters

###### channels

`number`

The number of audio channels (1 to 32).

###### Returns

`void`

###### Implementation of

```ts
RecordAction.channels
```

##### endOnKey

###### Get Signature

```ts
get endOnKey(): undefined | string;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:146](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L146)

Getter for the character that signals the end of recording.

###### Returns

`undefined` \| `string`

- The character that signals the end of recording.

###### Set Signature

```ts
set endOnKey(character): void;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:156](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L156)

Setter for the DTMF key that ends the recording.

###### Throws

- If the character is not a valid DTMF key.

###### Parameters

###### character

`string`

The DTMF key that ends the recording (e.g., "0", "*", "#").

###### Returns

`void`

###### Implementation of

```ts
RecordAction.endOnKey
```

##### endOnSilence

###### Get Signature

```ts
get endOnSilence(): undefined | number;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:170](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L170)

Getter for the duration of silence (in seconds) that signals the end of recording.

###### Returns

`undefined` \| `number`

- The duration of silence (in seconds) that signals the end of recording.

###### Set Signature

```ts
set endOnSilence(numSeconds): void;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:180](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L180)

Setter for the duration of silence to end the recording.

###### Throws

- If the duration value is out of the valid range.

###### Parameters

###### numSeconds

`number`

The duration of silence in seconds (3 to 10 seconds).

###### Returns

`void`

###### Implementation of

```ts
RecordAction.endOnSilence
```

##### split

###### Get Signature

```ts
get split(): "conversation";
```

Defined in: [voice/lib/classes/NCCO/Record.ts:195](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L195)

Getter for the recording split type.

###### Returns

`"conversation"`

- The recording split type, which is always 'conversation'.

###### Set Signature

```ts
set split(splitType): void;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:205](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L205)

Setter for the recording split type.

###### Throws

- Throws an error if the splitType is not 'conversation'.

###### Parameters

###### splitType

`string`

The recording split type. Must be set to 'conversation'.

###### Returns

`void`

###### Implementation of

```ts
RecordAction.split
```

##### timeout

###### Get Signature

```ts
get timeout(): undefined | number;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:218](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L218)

Getter for the recording timeout duration in seconds.

###### Returns

`undefined` \| `number`

- The recording timeout duration in seconds.

###### Set Signature

```ts
set timeout(seconds): void;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:228](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L228)

Setter for the recording timeout.

###### Throws

- If the timeout value is out of the valid range.

###### Parameters

###### seconds

`number`

The maximum recording duration in seconds (3 to 7200 seconds).

###### Returns

`void`

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): RecordAction;
```

Defined in: [voice/lib/classes/NCCO/Record.ts:243](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Record.ts#L243)

Serializes the Record action to NCCO format.

###### Returns

`RecordAction`

- The serialized Record action.

***

### Stream

Defined in: [voice/lib/classes/NCCO/Stream.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L10)

Represents a Stream action in a Nexmo Call Control Object (NCCO).

This action allows streaming audio into the call.

#### Implements

- `StreamAction`
- `Serializable`

#### Constructors

##### Constructor

```ts
new Stream(
   streamUrl, 
   level?, 
   bargeIn?, 
   loop?): Stream;
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L44)

Creates a new Stream action.

###### Parameters

###### streamUrl

`string`

The URL of the audio stream.

###### level?

`number`

The audio level at which to play the stream (optional).

###### bargeIn?

`boolean`

Indicates whether the stream should allow barge-in (optional).

###### loop?

`number`

The number of times to loop the audio (optional).

###### Returns

[`Stream`](#stream-1)

#### Properties

##### action

```ts
action: STREAM = NCCOActions.STREAM;
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L14)

The action type for this NCCO action.

###### Implementation of

```ts
StreamAction.action
```

##### bargeIn?

```ts
optional bargeIn: boolean;
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L29)

Indicates whether the stream should allow barge-in (optional).

###### Implementation of

```ts
StreamAction.bargeIn
```

##### level?

```ts
optional level: number;
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L24)

The audio level at which to play the stream (optional).

###### Implementation of

```ts
StreamAction.level
```

##### loop?

```ts
optional loop: number;
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L34)

The number of times to loop the audio (optional).

###### Implementation of

```ts
StreamAction.loop
```

##### streamUrl

```ts
streamUrl: string[];
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L19)

An array of stream URLs to play audio from.

###### Implementation of

```ts
StreamAction.streamUrl
```

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): StreamAction;
```

Defined in: [voice/lib/classes/NCCO/Stream.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Stream.ts#L68)

Serializes the Stream action to a Nexmo Call Control Object (NCCO).

###### Returns

`StreamAction`

- The serialized Stream action.

###### Implementation of

```ts
Serializable.serializeToNCCO
```

***

### Talk

Defined in: [voice/lib/classes/NCCO/Talk.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L10)

Represents a Talk action in a Nexmo Call Control Object (NCCO).

This action allows the text-to-speech (TTS) synthesis of spoken words in the call.

#### Implements

- `TalkAction`
- `Serializable`

#### Constructors

##### Constructor

```ts
new Talk(
   text, 
   bargeIn?, 
   loop?, 
   level?, 
   language?, 
   style?, 
   premium?): Talk;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:62](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L62)

Creates a new Talk action.

###### Parameters

###### text

`string`

The text to be spoken during the call.

###### bargeIn?

`boolean`

Indicates whether the talk action allows barge-in (optional).

###### loop?

`number`

The number of times to loop the speech (optional).

###### level?

`string`

The audio level at which to play the speech (optional).

###### language?

`string`

The language for the text-to-speech synthesis (optional).

###### style?

`string`

The speech style (optional).

###### premium?

`boolean`

Indicates whether to use premium text-to-speech (optional).

###### Returns

[`Talk`](#talk-1)

#### Properties

##### action

```ts
action: TALK = NCCOActions.TALK;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L14)

The action type for this NCCO action.

###### Implementation of

```ts
TalkAction.action
```

##### bargeIn?

```ts
optional bargeIn: boolean;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L24)

Indicates whether the talk action allows barge-in (optional).

###### Implementation of

```ts
TalkAction.bargeIn
```

##### language?

```ts
optional language: string;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L39)

The language for the text-to-speech synthesis (optional).

###### Implementation of

```ts
TalkAction.language
```

##### level?

```ts
optional level: string;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L34)

The audio level at which to play the speech (optional).

###### Implementation of

```ts
TalkAction.level
```

##### loop?

```ts
optional loop: number;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L29)

The number of times to loop the speech (optional).

###### Implementation of

```ts
TalkAction.loop
```

##### premium?

```ts
optional premium: boolean;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L49)

Indicates whether to use premium text-to-speech (optional).

###### Implementation of

```ts
TalkAction.premium
```

##### style?

```ts
optional style: string;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L44)

The speech style (optional).

###### Implementation of

```ts
TalkAction.style
```

##### text

```ts
text: string;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L19)

The text to be spoken during the call.

###### Implementation of

```ts
TalkAction.text
```

#### Methods

##### serializeToNCCO()

```ts
serializeToNCCO(): TalkAction;
```

Defined in: [voice/lib/classes/NCCO/Talk.ts:98](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/classes/NCCO/Talk.ts#L98)

Serializes the Talk action to a Nexmo Call Control Object (NCCO).

###### Returns

`TalkAction`

- The serialized Talk action.

###### Implementation of

```ts
Serializable.serializeToNCCO
```

***

### Voice

Defined in: [voice/lib/voice.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L103)

A Clint to make calls to the Vonage Voice API.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

#### Examples

Create a standalone Voice client

```ts
import { Voice } from '@vonage/voice';

const voiceClient = new Voice({
 apiKey: VONAGE_API_KEY,
 apiSecret: VONAGE_API_SECRET
});
```

Create an Voice client from the Vonage client

```ts
import { Vonage } from '@vonage/server-client';

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
});

const voiceClient = vonage.voice;
```

#### Extends

- [`Client`](Vonage-Server-Client.md#client)

#### Constructors

##### Constructor

```ts
new Voice(credentials, options?): Voice;
```

Defined in: server-client/dist/lib/client.d.ts:35

Creates a new instance of the Client.

###### Parameters

###### credentials

The authentication credentials or an authentication instance.

[`AuthInterface`](Vonage-Auth.md#authinterface) | [`AuthParams`](Vonage-Auth.md#authparams)

###### options?

[`ConfigParams`](Vonage-Server-Client.md#configparams)

Optional configuration settings for the client.

###### Returns

[`Voice`](#voice)

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor)

#### Properties

##### auth

```ts
protected auth: AuthInterface;
```

Defined in: server-client/dist/lib/client.d.ts:24

The authentication instance responsible for generating authentication headers and query parameters.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth)

##### authType

```ts
protected authType: AuthenticationType = AuthenticationType.JWT;
```

Defined in: [voice/lib/voice.ts:104](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L104)

The type of authentication used for the client's requests.

###### Overrides

[`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype)

##### config

```ts
protected config: ConfigParams;
```

Defined in: server-client/dist/lib/client.d.ts:28

Configuration settings for the client, including default hosts for various services and other request settings.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config)

##### transformers

```ts
static transformers: object;
```

Defined in: server-client/dist/lib/client.d.ts:11

Static property containing utility transformers.

###### camelCaseObjectKeys

```ts
camelCaseObjectKeys: PartialTransformFunction;
```

###### kebabCaseObjectKeys

```ts
kebabCaseObjectKeys: PartialTransformFunction;
```

###### omit()

```ts
omit: (keys, obj) => TransformedObject;
```

###### Parameters

###### keys

`string`[]

###### obj

[`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform)

###### Returns

[`TransformedObject`](Vonage-Server-Client.md#transformedobject)

###### snakeCaseObjectKeys

```ts
snakeCaseObjectKeys: PartialTransformFunction;
```

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers)

#### Methods

##### addAuthenticationToRequest()

```ts
addAuthenticationToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:43

Adds the appropriate authentication headers or parameters to the request based on the authentication type.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addAuthenticationToRequest`](Vonage-Server-Client.md#client#addauthenticationtorequest)

##### addBasicAuthToRequest()

```ts
protected addBasicAuthToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:71

Adds basic authentication headers to the request.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addBasicAuthToRequest`](Vonage-Server-Client.md#client#addbasicauthtorequest)

##### addJWTToRequest()

```ts
protected addJWTToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:64

Adds a JWT to the request.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addJWTToRequest`](Vonage-Server-Client.md#client#addjwttorequest)

##### addQueryKeySecretToRequest()

```ts
protected addQueryKeySecretToRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:57

Adds API key and secret to the request.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequest`](Vonage-Server-Client.md#client#addquerykeysecrettorequest)

##### addQueryKeySecretToRequestBody()

```ts
protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:50

Adds API key and secret to the request body.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options to which authentication needs to be added.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The request options with the added authentication.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequestBody`](Vonage-Server-Client.md#client#addquerykeysecrettorequestbody)

##### callAction()

```ts
protected callAction(
   uuid, 
   action, 
destination?): Promise<void>;
```

Defined in: [voice/lib/voice.ts:678](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L678)

Send a call action to a specific call identified by its UUID.

###### Parameters

###### uuid

`string`

The UUID of the call to which the action should be applied.

###### action

`string`

The action to perform on the call (e.g., 'hangup', 'mute', 'unmute').

###### destination?

`NCCODestination`

The destination details for transfer actions.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call action has been successfully executed.

###### Example

```ts
await voiceClient.callAction(CALL_UUID, 'mute');
```

##### createOutboundCall()

```ts
createOutboundCall(call): Promise<CallResult>;
```

Defined in: [voice/lib/voice.ts:270](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L270)

Initiates an outbound call with the specified configuration.

###### Parameters

###### call

[`OutboundCall`](#outboundcall)

The configuration for the outbound call.

###### Returns

`Promise`\<[`CallResult`](#callresult)\>

A promise that resolves to the result of the outbound call initiation.

###### Examples

Create a call with answer NCCO
```ts
const call = await voiceClient.createOutboundCall({
  to: [{
    type: 'phone',
    number: TO_NUMBER
  }],
  asnwer_url: ['https://example.com/answer'],
});

console.log(call.uuid);

```

Create a call with answer URL
```ts
const call = await voiceClient.createOutboundCall({
  to: [{
    type: 'phone',
    number: TO_NUMBER
  }],
  ncco: [{
    action: 'talk',
    text: 'This is a text to speech call from Vonage'
  }]
});

console.log(call.uuid);
```

##### downloadRecording()

```ts
downloadRecording(file, path): Promise<void>;
```

Defined in: [voice/lib/voice.ts:637](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L637)

Download the recording of a call to the specified file path.

###### Parameters

###### file

`string`

The name or recording id of the recording file to download.

###### path

`string`

The local file path where the recording will be saved.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the recording has been successfully downloaded.

###### Example

```ts
await voiceClient.downloadRecording(RECORDING_UUID, './recording.mp3');
```

##### downloadTranscription()

```ts
downloadTranscription(file, path): Promise<void>;
```

Defined in: [voice/lib/voice.ts:657](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L657)

Download the transcription of a call to the specified file path.

###### Parameters

###### file

`string`

The name or transcription id of the recording file to download.

###### path

`string`

The local file path where the transcription will be saved.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the transcription has been successfully downloaded.

###### Example

```ts
await voiceClient.downloadTranscription(TRANSCRIPTION_UUID, './transcription.txt');
```

##### earmuffCall()

```ts
earmuffCall(uuid): Promise<void>;
```

Defined in: [voice/lib/voice.ts:606](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L606)

Places a call on earmuff, muting the audio for all participants except the user.

###### Parameters

###### uuid

`string`

The UUID of the call to earmuff.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully earmuffed.

###### Example

```ts
await voiceClient.earmuffCall(CALL_UUID);
```

##### getAllCalls()

```ts
getAllCalls(params): AsyncGenerator<CallDetail, void & CommonCallFields & BasicCallDetail & object, undefined>;
```

Defined in: [voice/lib/voice.ts:119](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L119)

Retrieves details of all calls using pagination.

###### Parameters

###### params

[`GetCallDetailsParameters`](#getcalldetailsparameters) = `{}`

Optional parameters for filtering and pagination.

###### Returns

`AsyncGenerator`\<[`CallDetail`](#calldetail), `void` & [`CommonCallFields`](#commoncallfields) & [`BasicCallDetail`](#basiccalldetail) & `object`, `undefined`\>

An async generator that yields call details or void when there are no more results.

###### Example

```ts
for await (const call of voiceClient.getAllCalls()) {
  console.log(call.startTime);
}
```

##### getCall()

```ts
getCall(uuid): Promise<CallDetail>;
```

Defined in: [voice/lib/voice.ts:226](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L226)

Retrieves detailed information about a specific call using its UUID.

###### Parameters

###### uuid

`string`

The UUID of the call to retrieve details for.

###### Returns

`Promise`\<[`CallDetail`](#calldetail)\>

A promise that resolves to detailed information about the call.

###### Example

```ts
const call = await voiceClient.getCall('CALL_UUID');
console.log(call.startTime);
```

##### getCallsPage()

```ts
getCallsPage(params): Promise<CallPageResponse>;
```

Defined in: [voice/lib/voice.ts:178](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L178)

Retrieves a page of call details based on the specified parameters.

###### Parameters

###### params

[`GetCallDetailsParameters`](#getcalldetailsparameters)

Optional parameters for filtering and pagination.

###### Returns

`Promise`\<[`CallPageResponse`](#callpageresponse)\>

A promise that resolves to a page of call details.

###### Examples

```ts
const page = await voiceClient.getCallsPage();
for (const call of page._embedded.calls) {
  console.log(call.startTime);
}
```

Get the next page of call details
```ts
const page = await voiceClient.getCallsPage({
  pageSize: 4,
  recordIndex: 10,
});
for (const call of page._embedded.calls) {
  console.log(call.startTime);
}
```

Get all started calls
```ts
import { CallStatus } from '@vonage/voice';

const page = await voiceClient.getCallsPage({
  pageSize: 4,
  recordIndex: 10,
  status: CallStatus.STARTED,
});
for (const call of page._embedded.calls) {
  console.log(call.startTime);
}
```

##### getConfig()

```ts
getConfig(): ConfigParams;
```

Defined in: server-client/dist/lib/client.d.ts:36

###### Returns

[`ConfigParams`](Vonage-Server-Client.md#configparams)

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`getConfig`](Vonage-Server-Client.md#client#getconfig)

##### hangupCall()

```ts
hangupCall(uuid): Promise<void>;
```

Defined in: [voice/lib/voice.ts:561](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L561)

Hang up an active call.

###### Parameters

###### uuid

`string`

The UUID of the call to hang up.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully hung up.

###### Example

```ts
await voiceClient.hangupCall(CALL_UUID);
```

##### muteCall()

```ts
muteCall(uuid): Promise<void>;
```

Defined in: [voice/lib/voice.ts:576](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L576)

Mute an active call.

###### Parameters

###### uuid

`string`

The UUID of the call to mute.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully muted.

###### Example

```ts
await voiceClient.muteCall(CALL_UUID);
```

##### parseResponse()

```ts
protected parseResponse<T>(request, response): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:168

Parses the response based on its content type.

###### Type Parameters

###### T

`T`

The expected type of the parsed response data.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options.

###### response

`Response`

The raw response from the request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The parsed response.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`parseResponse`](Vonage-Server-Client.md#client#parseresponse)

##### playDTMF()

```ts
playDTMF(uuid, digits): Promise<CallUpdateResult>;
```

Defined in: [voice/lib/voice.ts:323](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L323)

Plays DTMF (Dual-Tone Multi-Frequency) tones on an active call.

###### Parameters

###### uuid

`string`

The UUID of the call on which to play DTMF tones.

###### digits

`string`

The DTMF tones to play.

###### Returns

`Promise`\<[`CallUpdateResult`](#callupdateresult)\>

A promise that resolves to the result of playing DTMF tones on the call.

###### Example

```ts
const result = await voiceClient.playDTMF('CALL_UUID', '1234');
console.log(result.status);
```

##### playTTS()

```ts
playTTS(uuid, action): Promise<CallUpdateResult>;
```

Defined in: [voice/lib/voice.ts:396](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L396)

Plays text-to-speech (TTS) audio on an active call.

###### Parameters

###### uuid

`string`

The UUID of the call on which to play TTS audio.

###### action

`TalkAction`

The TTS action configuration.

###### Returns

`Promise`\<[`CallUpdateResult`](#callupdateresult)\>

A promise that resolves to the result of playing TTS audio on the call.

###### Example

```ts
const result = await voiceClient.playTTS(
  CALL_UUID,
  {
    text: 'This is a text to speech call from Vonage',
  },
);

console.log(result.status);
```

##### prepareBody()

```ts
protected prepareBody(request): undefined | string;
```

Defined in: server-client/dist/lib/client.d.ts:158

Prepares the body for the request based on the content type.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The request options.

###### Returns

`undefined` \| `string`

- The prepared request body as a string or undefined.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`prepareBody`](Vonage-Server-Client.md#client#preparebody)

##### prepareRequest()

```ts
protected prepareRequest(request): Promise<VetchOptions>;
```

Defined in: server-client/dist/lib/client.d.ts:151

Prepares the request with necessary headers, authentication, and query parameters.

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The initial request options.

###### Returns

`Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\>

- The modified request options.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`prepareRequest`](Vonage-Server-Client.md#client#preparerequest)

##### search()

```ts
search(filter?): Promise<CallPageResponse>;
```

Defined in: [voice/lib/voice.ts:210](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L210)

Searches for call details based on the provided filter.

###### Parameters

###### filter?

[`GetCallDetailsParameters`](#getcalldetailsparameters)

Optional filter criteria to narrow down the search.

###### Returns

`Promise`\<[`CallPageResponse`](#callpageresponse)\>

A promise that resolves to a page of call details matching the filter.

###### Example

```ts
const page = await voiceClient.search({
  pageSize: 4,
});

for (const call of page._embedded.calls) {
  console.log(call.startTime);
  console.log(call.status);
  console.log(call.direction);
  console.log(call.duration);
};
```

##### sendDeleteRequest()

```ts
sendDeleteRequest<T>(url): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:78

Sends a DELETE request to the specified URL.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the DELETE request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the DELETE request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendDeleteRequest`](Vonage-Server-Client.md#client#senddeleterequest)

##### sendFormSubmitRequest()

```ts
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:86

Sends a POST request with form data to the specified URL.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the POST request.

###### payload?

`Record`\<`string`, `undefined` \| `string`\>

Optional payload containing form data to send with the POST request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the POST request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendFormSubmitRequest`](Vonage-Server-Client.md#client#sendformsubmitrequest)

##### sendGetRequest()

```ts
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:94

Sends a GET request to the specified URL with optional query parameters.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the GET request.

###### queryParams?

Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the GET request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendGetRequest`](Vonage-Server-Client.md#client#sendgetrequest)

##### sendPatchRequest()

```ts
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:104

Sends a PATCH request to the specified URL with an optional payload.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the PATCH request.

###### payload?

Optional payload to be sent as the body of the PATCH request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the PATCH request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendPatchRequest`](Vonage-Server-Client.md#client#sendpatchrequest)

##### sendPostRequest()

```ts
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:114

Sends a POST request to the specified URL with an optional payload.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the POST request.

###### payload?

Optional payload to be sent as the body of the POST request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the POST request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendPostRequest`](Vonage-Server-Client.md#client#sendpostrequest)

##### sendPutRequest()

```ts
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:124

Sends a PUT request to the specified URL with an optional payload.

###### Type Parameters

###### T

`T`

###### Parameters

###### url

`string`

The URL endpoint for the PUT request.

###### payload?

Optional payload to be sent as the body of the PUT request.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the PUT request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendPutRequest`](Vonage-Server-Client.md#client#sendputrequest)

##### sendRequest()

```ts
sendRequest<T>(request): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:144

Sends a request adding necessary headers, handling authentication, and parsing the response.

###### Type Parameters

###### T

`T`

###### Parameters

###### request

[`VetchOptions`](Vonage-Vetch.md#vetchoptions)

The options defining the request, including URL, method, headers, and data.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The parsed response from the request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendRequest`](Vonage-Server-Client.md#client#sendrequest)

##### sendRequestWithData()

```ts
sendRequestWithData<T>(
   method, 
   url, 
payload?): Promise<VetchResponse<T>>;
```

Defined in: server-client/dist/lib/client.d.ts:135

Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.

###### Type Parameters

###### T

`T`

###### Parameters

###### method

The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).

[`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch)

###### url

`string`

The URL endpoint for the request.

###### payload?

Optional payload to be sent as the body of the request, JSON-encoded.

###### Returns

`Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\>

- The response from the request.

###### Inherited from

[`Client`](Vonage-Server-Client.md#client).[`sendRequestWithData`](Vonage-Server-Client.md#client#sendrequestwithdata)

##### stopStreamAudio()

```ts
stopStreamAudio(uuid): Promise<CallUpdateResult>;
```

Defined in: [voice/lib/voice.ts:489](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L489)

Stop streaming audio to an active call.

###### Parameters

###### uuid

`string`

The UUID of the call from which to stop streaming audio.

###### Returns

`Promise`\<[`CallUpdateResult`](#callupdateresult)\>

A promise that resolves to the result of stopping audio streaming to the call.

###### Example

```ts
const result = await voiceClient.stopStreamAudio(CALL_UUID);
console.log(result.message);
```

##### stopTTS()

```ts
stopTTS(uuid): Promise<CallUpdateResult>;
```

Defined in: [voice/lib/voice.ts:429](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L429)

Stops any ongoing text-to-speech (TTS) audio playback on an active call.

###### Parameters

###### uuid

`string`

The UUID of the call on which to stop TTS audio playback.

###### Returns

`Promise`\<[`CallUpdateResult`](#callupdateresult)\>

A promise that resolves to the result of stopping TTS audio playback on the call.

###### Example

```ts
const result = await voiceClient.stopTTS(CALL_UUID);
console.log(result.status);
```

##### streamAudio()

```ts
streamAudio(
   uuid, 
   url, 
   loop?, 
volumeLevel?): Promise<UpdateCallResponse>;
```

Defined in: [voice/lib/voice.ts:456](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L456)

Stream audio to an active call, allowing you to play audio files or live audio streams.

###### Parameters

###### uuid

`string`

The UUID of the call to which to stream audio.

###### url

`string`

The URL of the audio stream to play.

###### loop?

`number` = `1`

The number of times to loop the audio stream (default is 1).

###### volumeLevel?

`number` = `0.0`

The volume level of the audio stream (0.0 to 1.0, default is 0.0).

###### Returns

`Promise`\<[`UpdateCallResponse`](#updatecallresponse)\>

A promise that resolves to the result of streaming audio to the call.

###### Example

```ts
const result = await voiceClient.streamAudio(CALL_UUID, 'https://example.com/audio.mp3');
console.log(result.message);
```

##### subscribeDTMF()

```ts
subscribeDTMF(uuid, eventUrl): Promise<void>;
```

Defined in: [voice/lib/voice.ts:353](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L353)

Register a listener to receive asynchronous DTMF inputs from a call

This is only applicable to Input NCCO events with the mode set to
asynchronous. The payload delivered to this URL will be an Input webhook
event with a single DTMF digit every time the callee enters DTMF into the
call.

###### Parameters

###### uuid

`string`

The UUID of the call leg

###### eventUrl

`string`

The The URL to send DTMF events to, as a POST request.

###### Returns

`Promise`\<`void`\>

A promise that resolves to the result

###### Example

```ts
const result = await voiceClient.subscribeDTMF('CALL_UUID', 'https://example.com/dtmf');
console.log(result.status);
```

##### transferCallWithNCCO()

```ts
transferCallWithNCCO(uuid, ncco): Promise<void>;
```

Defined in: [voice/lib/voice.ts:518](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L518)

Transfer an active call to a new destination using a Nexmo Call Control Object (NCCO).

###### Parameters

###### uuid

`string`

The UUID of the call to transfer.

###### ncco

[`NCCOAction`](#nccoaction)[]

The NCCO actions defining the transfer destination.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully transferred.

###### Example

```ts
await voiceClient.transferCallWithNCCO(
  CALL_UUID,
  [{
    action: 'talk',
    text: 'You will now be transferred to a new destination''
  }],
)
```

##### transferCallWithURL()

```ts
transferCallWithURL(uuid, url): Promise<void>;
```

Defined in: [voice/lib/voice.ts:544](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L544)

Transfer an active call to a new destination using a URL.

###### Parameters

###### uuid

`string`

The UUID of the call to transfer.

###### url

`string`

The URL of the transfer destination.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully transferred.

###### Example

```ts
await voiceClient.transferCallWithURL(
  CALL_UUID,
  'https://example.com/transfer',
);
```

##### unearmuffCall()

```ts
unearmuffCall(uuid): Promise<void>;
```

Defined in: [voice/lib/voice.ts:621](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L621)

Remove an earmuff from a call, allowing all participants to hear each other again.

###### Parameters

###### uuid

`string`

The UUID of the call to unearmuff.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully unearmuffed.

###### Example

```ts
await voiceClient.unearmuffCall(CALL_UUID);
```

##### unmuteCall()

```ts
unmuteCall(uuid): Promise<void>;
```

Defined in: [voice/lib/voice.ts:591](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L591)

Unmute a muted call, allowing audio to be transmitted again.

###### Parameters

###### uuid

`string`

The UUID of the call to unmute.

###### Returns

`Promise`\<`void`\>

A promise that resolves when the call has been successfully unmuted.

###### Example

```ts
await voiceClient.unmuteCall(CALL_UUID);
```

##### unsubscribeDTMF()

```ts
unsubscribeDTMF(uuid): Promise<void>;
```

Defined in: [voice/lib/voice.ts:371](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/voice.ts#L371)

Removes the registered DTMF listener

###### Parameters

###### uuid

`string`

The UUID of the call leg

###### Returns

`Promise`\<`void`\>

A promise that resolves to the result

###### Example

```ts
const result = await voiceClient.subscribeDTMF('CALL_UUID', 'https://example.com/dtmf');
console.log(result.status);
```

## Interfaces

### NCCOTransfer

Defined in: [voice/lib/interfaces/NCCO/Transfer.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/Transfer.ts#L6)

Represents a Nexmo Call Control Object (NCCO) transfer action.

#### Properties

##### action

```ts
action: string;
```

Defined in: [voice/lib/interfaces/NCCO/Transfer.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/Transfer.ts#L10)

The action type, which is 'transfer'.

##### destination

```ts
destination: object;
```

Defined in: [voice/lib/interfaces/NCCO/Transfer.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/Transfer.ts#L15)

The destination of the transfer, including the type and NCCO actions.

###### ncco

```ts
ncco: NCCOAction[];
```

The NCCO actions to be executed at the destination.

###### type

```ts
type: string;
```

The type of destination, which is 'ncco'.

***

### URLTransfer

Defined in: [voice/lib/interfaces/NCCO/Transfer.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/Transfer.ts#L31)

Represents a Nexmo Call Control Object (NCCO) URL transfer action.

#### Properties

##### action

```ts
action: string;
```

Defined in: [voice/lib/interfaces/NCCO/Transfer.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/Transfer.ts#L35)

The action type, which is 'transfer'.

##### destination

```ts
destination: object;
```

Defined in: [voice/lib/interfaces/NCCO/Transfer.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/Transfer.ts#L40)

The destination of the transfer, including the type and URL.

###### type

```ts
type: string;
```

The type of destination, which is 'url'.

###### url

```ts
url: string[];
```

The URL to which the call will be transferred.

## Type Aliases

### Action

```ts
type Action = NCCOAction;
```

Defined in: [voice/lib/types/NCCO/Action.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/NCCO/Action.ts#L7)

Represents a Nexmo Call Control Object (NCCO) action that defines the behavior of a call.
This type is an alias for the `NCCOAction` type.

***

### AdvancedMachineDetection

```ts
type AdvancedMachineDetection = object;
```

Defined in: [voice/lib/types/AdvancedMachineDetection.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/AdvancedMachineDetection.ts#L10)

Represents advanced settings for machine detection during a call, including
behavior, mode, and optional beep timeout.

#### Properties

##### beepTimeout?

```ts
optional beepTimeout: number;
```

Defined in: [voice/lib/types/AdvancedMachineDetection.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/AdvancedMachineDetection.ts#L25)

(Optional) The timeout duration (in seconds) for detecting a beep during
machine detection.

##### behavior

```ts
behavior: MachineDetectionBehavior;
```

Defined in: [voice/lib/types/AdvancedMachineDetection.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/AdvancedMachineDetection.ts#L14)

The behavior to follow when machine detection occurs.

##### mode

```ts
mode: AdvancedMachineDetectionMode;
```

Defined in: [voice/lib/types/AdvancedMachineDetection.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/AdvancedMachineDetection.ts#L19)

The mode of advanced machine detection.

***

### AppEndpoint

```ts
type AppEndpoint = object & Record<string, unknown>;
```

Defined in: [voice/lib/types/Endpoint/AppEndpoint.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/AppEndpoint.ts#L5)

Connect the call to a RTC capable application

#### Type declaration

##### type

```ts
type: "app";
```

Specifies the type of endpoint, which is 'app' for RTC capable
applications.

##### user

```ts
user: string;
```

The username of ther user to connect too.

The username must have been added using
[https://developer.nexmo.com/api/conversation#createUser](https://developer.nexmo.com/api/conversation#createUser)

***

### BasicCallDetail

```ts
type BasicCallDetail = object;
```

Defined in: [voice/lib/types/BasicCallDetail.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/BasicCallDetail.ts#L6)

Represents basic details of a call, including its UUID, conversation UUID, duration, and status.

#### Properties

##### conversationUUID

```ts
conversationUUID: string;
```

Defined in: [voice/lib/types/BasicCallDetail.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/BasicCallDetail.ts#L15)

The UUID of the conversation associated with the call.

##### duration

```ts
duration: string;
```

Defined in: [voice/lib/types/BasicCallDetail.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/BasicCallDetail.ts#L20)

The duration of the call in a string format.

##### status

```ts
status: CallStatus;
```

Defined in: [voice/lib/types/BasicCallDetail.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/BasicCallDetail.ts#L25)

The status of the call, indicating its current state.

##### uuid

```ts
uuid: string;
```

Defined in: [voice/lib/types/BasicCallDetail.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/BasicCallDetail.ts#L10)

The UUID of the call.

***

### CallDetail

```ts
type CallDetail = CommonCallFields & BasicCallDetail & object;
```

Defined in: [voice/lib/types/CallDetail.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallDetail.ts#L9)

Represents detailed information about a call, including common call fields, call direction, rate, price, start time,
end time, and network information.

#### Type declaration

##### direction

```ts
direction: CallDirection;
```

The direction of the call, indicating whether it is inbound or outbound.

##### endTime

```ts
endTime: string;
```

The end time of the call in a string format.

##### network

```ts
network: string;
```

The network information related to the call.

##### price

```ts
price: string;
```

The price of the call in a string format.

##### rate

```ts
rate: string;
```

The rate associated with the call in a string format.

##### startTime

```ts
startTime: string;
```

The start time of the call in a string format.

***

### CallDetailResponse

```ts
type CallDetailResponse = object & Omit<CallDetail, "conversationUUID" | "startTime" | "endTime" | "to" | "from"> & APILinks;
```

Defined in: [voice/lib/types/Responses/CallDetailResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CallDetailResponse.ts#L12)

Represents the response for retrieving call details.

#### Type declaration

##### conversation\_uuid

```ts
conversation_uuid: string;
```

The UUID of the conversation associated with the call.

##### end\_time

```ts
end_time: string;
```

The end time of the call.

##### start\_time

```ts
start_time: string;
```

The start time of the call.

##### to

```ts
to: CallEndpointResponse;
```

Information about the recipient (callee) of the call.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### CallEndpoint

```ts
type CallEndpoint = 
  | WebsocketEndpoint
  | PhoneEndpoint
  | SIPEndpoint
  | AppEndpoint
  | VBCEndpoint;
```

Defined in: [voice/lib/types/Endpoint/CallEndpoint.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/CallEndpoint.ts#L11)

Represents a call endpoint, which can be of different types such as Phone, SIP, VBC, or Websocket.
This type can be used to specify the destination for an outbound call.

***

### ~~CallEndpointObject~~

```ts
type CallEndpointObject = CallEndpoint;
```

Defined in: [voice/lib/interfaces/Endpoint/CallEndpointObject.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/Endpoint/CallEndpointObject.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the CallEndpoint type

***

### CallEndpointResponse

```ts
type CallEndpointResponse = 
  | PhoneEndpoint
  | WebsocketEndpoint
  | SIPEndpoint
  | VBCEndpoint;
```

Defined in: [voice/lib/types/Responses/CallEndpointResponse.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CallEndpointResponse.ts#L19)

Represents the response for a call endpoint, which can be one of the following:
- Phone endpoint
- Websocket endpoint
- SIP endpoint
- VBC (Vonage Business Cloud) endpoint

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### ~~CallListFilter~~

```ts
type CallListFilter = object & GetCallDetailsParameters;
```

Defined in: [voice/lib/types/Parameters/CallListFilter.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/CallListFilter.ts#L6)

#### Type declaration

##### ~~conversation\_uuid?~~

```ts
optional conversation_uuid: string;
```

##### ~~date\_end?~~

```ts
optional date_end: string;
```

##### ~~date\_start?~~

```ts
optional date_start: string;
```

##### ~~page\_size?~~

```ts
optional page_size: string;
```

##### ~~record\_index?~~

```ts
optional record_index: string;
```

#### Deprecated

Pelease use GetCallDetailsParameters instead

***

### CallPageResponse

```ts
type CallPageResponse = object & APILinks;
```

Defined in: [voice/lib/types/Responses/CallPageResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CallPageResponse.ts#L12)

Represents the response for a page of call details, including information
about the page itself and an array of call details.

#### Type declaration

##### \_embedded

```ts
_embedded: object;
```

An embedded object containing an array of call details.

###### \_embedded.calls

```ts
_embedded.calls: CallDetailResponse[];
```

An array of call details.

##### count

```ts
count: number;
```

The total count of call details in the response.

##### page\_size

```ts
page_size: number;
```

The number of call details per page.

##### record\_index

```ts
record_index: number;
```

The index of the first call detail in the current page.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### CallResult

```ts
type CallResult = object;
```

Defined in: [voice/lib/types/CallResult.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallResult.ts#L6)

Represents the result of a call, including the UUID, status, direction (inbound or outbound), and conversation UUID.

#### Properties

##### conversationUUID

```ts
conversationUUID: string;
```

Defined in: [voice/lib/types/CallResult.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallResult.ts#L25)

The UUID associated with the conversation related to the call.

##### direction

```ts
direction: "inbound" | "outbound";
```

Defined in: [voice/lib/types/CallResult.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallResult.ts#L20)

The direction of the call, specifying whether it is inbound or outbound.

##### status

```ts
status: CallStatus;
```

Defined in: [voice/lib/types/CallResult.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallResult.ts#L15)

The status of the call, indicating its current state or outcome.

##### uuid

```ts
uuid: string;
```

Defined in: [voice/lib/types/CallResult.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallResult.ts#L10)

The universally unique identifier (UUID) associated with the call.

***

### CallUpdateResult

```ts
type CallUpdateResult = object;
```

Defined in: [voice/lib/types/CallUpdateResult.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallUpdateResult.ts#L4)

Represents the result of updating a call, including the UUID and a message describing the update.

#### Properties

##### message

```ts
message: string;
```

Defined in: [voice/lib/types/CallUpdateResult.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallUpdateResult.ts#L13)

A message describing the update or the result of the call update operation.

##### uuid

```ts
uuid: string;
```

Defined in: [voice/lib/types/CallUpdateResult.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallUpdateResult.ts#L8)

The universally unique identifier (UUID) associated with the call.

***

### CallWithAnswerURL

```ts
type CallWithAnswerURL = CommonOutboundCall & object;
```

Defined in: [voice/lib/types/CallWithAnswerURL.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallWithAnswerURL.ts#L7)

Represents an outbound call with an answer URL, including common call properties and the answer URL information.

#### Type declaration

##### answerMethod?

```ts
optional answerMethod: HttpMethod;
```

The HTTP method used to send events to the answer URL(s), typically "GET" or "POST."

##### answerUrl

```ts
answerUrl: string[];
```

The URL(s) to which call events should be sent when the call is answered.

##### dtmfAnswer?

```ts
optional dtmfAnswer: string;
```

Provide DTMF digits to send when the call is answerMethod

***

### CallWithNCCO

```ts
type CallWithNCCO = CommonOutboundCall & object;
```

Defined in: [voice/lib/types/CallWithNCCO.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CallWithNCCO.ts#L7)

Represents an outbound call with associated Nexmo Call Control Objects (NCCO) actions.

#### Type declaration

##### ncco

```ts
ncco: NCCOAction[];
```

An array of NCCO actions to be executed during the call.

***

### CommonCallFields

```ts
type CommonCallFields = object;
```

Defined in: [voice/lib/types/CommonCallFields.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CommonCallFields.ts#L6)

Represents common fields for defining an outbound call, including the caller (from) and recipient (to) endpoints.

#### Properties

##### from

```ts
from: Omit<PSTNEndpoint, "dtmfAnswer">;
```

Defined in: [voice/lib/types/CommonCallFields.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CommonCallFields.ts#L10)

The caller's endpoint information, excluding DTMF answer details.

##### to

```ts
to: CallEndpoint;
```

Defined in: [voice/lib/types/CommonCallFields.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CommonCallFields.ts#L15)

The recipient's endpoint information for the call.

***

### CommonOutboundCall

```ts
type CommonOutboundCall = Omit<CommonCallFields, "to"> & object;
```

Defined in: [voice/lib/types/CommonOutboundCall.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/CommonOutboundCall.ts#L10)

Represents common fields for defining an outbound call, including the caller (from) and recipient (to) endpoints,
along with additional call parameters.

#### Type declaration

##### advancedMachineDetection?

```ts
optional advancedMachineDetection: AdvancedMachineDetection;
```

Advanced machine detection settings for the call.

##### eventMethod?

```ts
optional eventMethod: HttpMethod;
```

The HTTP method to use when sending events to the specified event URLs.

##### eventUrl?

```ts
optional eventUrl: string[];
```

An array of URLs to notify with call events.

##### lengthTimer?

```ts
optional lengthTimer: number;
```

The length of time to wait for call answer, in seconds.

##### machineDetection?

```ts
optional machineDetection: MachineDetectionBehavior;
```

Specifies the behavior for machine detection during the call.

##### ringingTimer?

```ts
optional ringingTimer: number;
```

The length of time to wait for the call to ring before considering it unanswered, in seconds.

##### to

```ts
to: CallEndpoint[];
```

An array of recipient endpoints for the call.

***

### ~~ConnectAction~~

```ts
type ConnectAction = ConnectActionType;
```

Defined in: [voice/lib/interfaces/NCCO/ConnectAction.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/ConnectAction.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the ConnectActionType type

***

### ~~ConversationAction~~

```ts
type ConversationAction = ConnectionActionType;
```

Defined in: [voice/lib/interfaces/NCCO/ConversationAction.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/ConversationAction.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the ConnectionActionType type

***

### CreateCallParameters

```ts
type CreateCallParameters = OutboundCall;
```

Defined in: [voice/lib/types/Parameters/CreateCallParameters.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/CreateCallParameters.ts#L3)

***

### CreateCallRequest

```ts
type CreateCallRequest = object & Omit<OutboundCall, 
  | "randomFromNumber"
  | "eventUrl"
  | "machineDetection"
  | "advancedMachineDetection"
  | "lengthTimer"
| "ringingTimer">;
```

Defined in: [voice/lib/types/Requests/CreateCallRequest.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Requests/CreateCallRequest.ts#L12)

Represents the request payload for creating a call, including various call settings.

#### Type declaration

##### advanced\_machine\_detection

```ts
advanced_machine_detection: object & Omit<AdvancedMachineDetection, "beepTimeout">;
```

Advanced machine detection settings, including beep timeout.

###### Type declaration

###### beep\_timeout?

```ts
optional beep_timeout: number;
```

The beep timeout setting for advanced machine detection.

##### event\_url?

```ts
optional event_url: string[];
```

An array of URLs for event callbacks during the call's lifecycle.

##### length\_timer?

```ts
optional length_timer: number;
```

The length timer setting for the call.

##### machine\_detection?

```ts
optional machine_detection: MachineDetection;
```

The type of machine detection to use for the call.

##### random\_from\_number?

```ts
optional random_from_number: boolean;
```

Specifies whether to use a random caller number for the call.

##### ringing\_timer?

```ts
optional ringing_timer: number;
```

The ringing timer setting for the call.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### CreateCallResponse

```ts
type CreateCallResponse = object;
```

Defined in: [voice/lib/types/Responses/CreateCallResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CreateCallResponse.ts#L8)

Represents the response for creating a call, including the call's UUID, status, direction, and conversation UUID.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

#### Properties

##### conversation\_uuid

```ts
conversation_uuid: string;
```

Defined in: [voice/lib/types/Responses/CreateCallResponse.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CreateCallResponse.ts#L27)

The UUID of the conversation associated with the call.

##### direction

```ts
direction: string;
```

Defined in: [voice/lib/types/Responses/CreateCallResponse.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CreateCallResponse.ts#L22)

The direction of the call (e.g., "outbound" or "inbound").

##### status

```ts
status: string;
```

Defined in: [voice/lib/types/Responses/CreateCallResponse.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CreateCallResponse.ts#L17)

The status of the created call.

##### uuid

```ts
uuid: string;
```

Defined in: [voice/lib/types/Responses/CreateCallResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CreateCallResponse.ts#L12)

The UUID of the created call.

***

### CreateOutboundCallResponse

```ts
type CreateOutboundCallResponse = object & Omit<BasicCallDetail, "conversationUUID">;
```

Defined in: [voice/lib/types/Responses/CreateOutboundCallResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/CreateOutboundCallResponse.ts#L10)

Represents the response for creating an outbound call, including the conversation UUID and basic call details.

#### Type declaration

##### conversation\_uuid

```ts
conversation_uuid: string;
```

The UUID of the conversation associated with the outbound call.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### ~~DTMFSettings~~

```ts
type DTMFSettings = DTMFSettingsType;
```

Defined in: [voice/lib/interfaces/NCCO/DTMFSettings.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/DTMFSettings.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the DTMFSettingsType type

***

### EarmuffCallParameters

```ts
type EarmuffCallParameters = object;
```

Defined in: [voice/lib/types/Parameters/EarmuffCallParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/EarmuffCallParameters.ts#L4)

Represents parameters for an "earmuff" action in a call.

#### Properties

##### action

```ts
action: "earmuff";
```

Defined in: [voice/lib/types/Parameters/EarmuffCallParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/EarmuffCallParameters.ts#L8)

The action to earmuff the call.

***

### GetCallDetailsParameters

```ts
type GetCallDetailsParameters = object;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L6)

Represents parameters for retrieving call details.

#### Properties

##### conversationUuid?

```ts
optional conversationUuid: string;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L40)

Optional: The conversation UUID for filtering calls.

##### dateEnd?

```ts
optional dateEnd: string;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L20)

Optional: The end date for filtering calls.

##### dateStart?

```ts
optional dateStart: string;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L15)

Optional: The start date for filtering calls.

##### order?

```ts
optional order: "asc" | "desc";
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L35)

Optional: The order in which calls are retrieved (ascending or descending).

##### pageSize?

```ts
optional pageSize: number;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L25)

Optional: The page size for pagination.

##### recordIndex?

```ts
optional recordIndex: number;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L30)

Optional: The record index for pagination.

##### status?

```ts
optional status: CallStatus;
```

Defined in: [voice/lib/types/Parameters/GetCallsDetailsParameters.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/GetCallsDetailsParameters.ts#L10)

Optional: The status of the calls to retrieve.

***

### GetCallDetailsRequest

```ts
type GetCallDetailsRequest = object & Omit<GetCallDetailsParameters, 
  | "dateEnd"
  | "dateStart"
  | "pageSize"
  | "recordIndex"
| "conversationUuid">;
```

Defined in: [voice/lib/types/Requests/GetCallsDetailsRequest.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Requests/GetCallsDetailsRequest.ts#L10)

Represents the request payload for retrieving call details with various filtering options.

#### Type declaration

##### conversation\_uuid?

```ts
optional conversation_uuid: string;
```

The UUID of the conversation to filter call records by.

##### date\_end?

```ts
optional date_end: string;
```

The end date for filtering call records.

##### date\_start?

```ts
optional date_start: string;
```

The start date for filtering call records.

##### page\_size?

```ts
optional page_size: number;
```

The maximum number of records to return per page.

##### record\_index?

```ts
optional record_index: number;
```

The record index for pagination.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### HangupCallParameters

```ts
type HangupCallParameters = object;
```

Defined in: [voice/lib/types/Parameters/HangupCallParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/HangupCallParameters.ts#L4)

Represents parameters for hanging up a call.

#### Properties

##### action

```ts
action: "hangup";
```

Defined in: [voice/lib/types/Parameters/HangupCallParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/HangupCallParameters.ts#L8)

The action indicating that the call should be hung up.

***

### ~~InputAction~~

```ts
type InputAction = InputActionType;
```

Defined in: [voice/lib/interfaces/NCCO/InputAction.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/InputAction.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the InputActionType type

***

### ~~IOutboundCallWithAnswerURL~~

```ts
type IOutboundCallWithAnswerURL = CallWithAnswerURL;
```

Defined in: [voice/lib/interfaces/OutboundCallWithAnswerURL.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/OutboundCallWithAnswerURL.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the CallWithAnswerURL type

***

### ~~IOutboundCallWithNCCO~~

```ts
type IOutboundCallWithNCCO = CallWithNCCO;
```

Defined in: [voice/lib/interfaces/OutboundCallWithNCCO.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/OutboundCallWithNCCO.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the CallWithNCCO type

***

### ModifyCallRequestParameters

```ts
type ModifyCallRequestParameters = 
  | EarmuffCallParameters
  | HangupCallParameters
  | MuteCallParameters
  | TransferCallParameters
  | UnearmuffCallParameters
  | UnmuteCallParameters;
```

Defined in: [voice/lib/types/Requests/ModifyCallRequest.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Requests/ModifyCallRequest.ts#L18)

Represents the parameters for modifying a call, including actions like
earmuff, hangup, mute, transfer, unearmuff, and unmute.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### MuteCallParameters

```ts
type MuteCallParameters = object;
```

Defined in: [voice/lib/types/Parameters/MuteCallParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/MuteCallParameters.ts#L4)

Represents parameters for muting a call.

#### Properties

##### action

```ts
action: "mute";
```

Defined in: [voice/lib/types/Parameters/MuteCallParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/MuteCallParameters.ts#L8)

The action indicating that the call should be muted.

***

### NCCOAction

```ts
type NCCOAction = 
  | ConnectAction
  | ConversationAction
  | InputAction
  | NotifyAction
  | RecordAction
  | StreamAction
  | TalkAction;
```

Defined in: [voice/lib/types/NCCO/NCCOActions.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/NCCO/NCCOActions.ts#L22)

Represents a Nexmo Call Control Object (NCCO) action, which can be one of the following types:
- ConnectAction
- ConversationAction
- InputAction
- NotifyAction
- RecordAction
- StreamAction
- TalkAction

An NCCO action defines a specific action or behavior in a call flow, and these actions can be combined
to create complex call scenarios when constructing NCCOs.

***

### ~~NotifyAction~~

```ts
type NotifyAction = NotifyActionType;
```

Defined in: [voice/lib/interfaces/NCCO/NotifyAction.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/NotifyAction.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the NotifyActionType type

***

### OutboundCall

```ts
type OutboundCall = 
  | CallWithNCCO
  | CallWithAnswerURL;
```

Defined in: [voice/lib/types/OutboundCall.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/OutboundCall.ts#L9)

Represents an outbound call, which can either include an answer URL (for simple call scenarios)
or an NCCO (Nexmo Call Control Object) for more complex call scenarios. Depending on the use case,
it can be either a `CallWithAnswerURL` or a `CallWithNCCO`.

***

### PhoneEndpoint

```ts
type PhoneEndpoint = object & Record<string, unknown>;
```

Defined in: [voice/lib/types/Endpoint/PhoneEndpoint.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/PhoneEndpoint.ts#L4)

Represents a phone endpoint, which can be used as a call destination.

#### Type declaration

##### dtmfAnswer?

```ts
optional dtmfAnswer: string;
```

Provide DTMF digits to send when the call is answered

##### number

```ts
number: string;
```

The phone number associated with the endpoint.

##### type

```ts
type: "phone";
```

Specifies the type of endpoint, which is 'phone' for phone numbers.

***

### ~~PhoneEndpointObject~~

```ts
type PhoneEndpointObject = PhoneEndpoint;
```

Defined in: [voice/lib/interfaces/Endpoint/PhoneEndpointObject.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/Endpoint/PhoneEndpointObject.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the PhoneEndpoint type

***

### PlayDTMFRequest

```ts
type PlayDTMFRequest = PlayDTMFParameters;
```

Defined in: [voice/lib/types/Requests/PlayDTMFRequest.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Requests/PlayDTMFRequest.ts#L10)

Represents the parameters for playing DTMF (Dual-Tone Multi-Frequency) tones during a call.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### PlayTTSParameters

```ts
type PlayTTSParameters = object;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L6)

Represents parameters for playing Text-to-Speech (TTS) in a call.

#### Properties

##### language?

```ts
optional language: TTSLanguages | string;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L15)

The language in which the text should be spoken. Optional.

##### level?

```ts
optional level: string;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L40)

The audio level for the TTS playback. Optional.

##### loop?

```ts
optional loop: number;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L35)

The number of times to loop the TTS playback. Optional.

##### premium?

```ts
optional premium: boolean;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L25)

Indicates if premium TTS features should be used. Optional.

##### style?

```ts
optional style: number;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L20)

The style or voice variant for the TTS. Optional.

##### text

```ts
text: string;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L10)

The text to be converted to speech and played in the call.

##### voiceName?

```ts
optional voiceName: TTSVoices;
```

Defined in: [voice/lib/types/Parameters/PlayTTSParameters.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/PlayTTSParameters.ts#L30)

The name of the specific TTS voice to use. Optional.

***

### PlayTTSRequest

```ts
type PlayTTSRequest = object & Omit<PlayTTSParameters, "voiceName">;
```

Defined in: [voice/lib/types/Requests/PlayTTSRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Requests/PlayTTSRequest.ts#L11)

Represents the parameters for playing text-to-speech (TTS) during a call.

#### Type declaration

##### voice\_name?

```ts
optional voice_name: TTSVoices;
```

The name of the TTS voice to use for speech synthesis.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### PSTNEndpoint

```ts
type PSTNEndpoint = object;
```

Defined in: [voice/lib/types/Endpoint/PSTNEndpoint.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/PSTNEndpoint.ts#L4)

Represents a PSTN (Public Switched Telephone Network) endpoint, which can be used as a call destination.

#### Properties

##### dtmfAnswer?

```ts
optional dtmfAnswer: string;
```

Defined in: [voice/lib/types/Endpoint/PSTNEndpoint.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/PSTNEndpoint.ts#L19)

An optional DTMF (Dual-Tone Multi-Frequency) answer string. When provided,
it enables automated call answering by sending DTMF tones.

##### number

```ts
number: string;
```

Defined in: [voice/lib/types/Endpoint/PSTNEndpoint.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/PSTNEndpoint.ts#L13)

The phone number associated with the endpoint.

##### type

```ts
type: "phone";
```

Defined in: [voice/lib/types/Endpoint/PSTNEndpoint.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/PSTNEndpoint.ts#L8)

Specifies the type of endpoint, which is 'phone' for phone numbers.

***

### ~~RecordAction~~

```ts
type RecordAction = RecordActionType;
```

Defined in: [voice/lib/interfaces/NCCO/RecordAction.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/RecordAction.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the RecordActionType type

***

### SIPEndpoint

```ts
type SIPEndpoint = object;
```

Defined in: [voice/lib/types/Endpoint/SIPEndpoint.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/SIPEndpoint.ts#L4)

Represents a SIP (Session Initiation Protocol) endpoint, which can be used as a call destination.

#### Properties

##### headers?

```ts
optional headers: Record<string, unknown>;
```

Defined in: [voice/lib/types/Endpoint/SIPEndpoint.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/SIPEndpoint.ts#L18)

An optional array of headers as key-value pairs. These headers can be included in the SIP request.

##### standardHeaders?

```ts
optional standardHeaders: object;
```

Defined in: [voice/lib/types/Endpoint/SIPEndpoint.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/SIPEndpoint.ts#L24)

Standard SIP INVITE headers. Unlike the headers property, these are not
prepended with X-.

###### User-to-User?

```ts
optional User-to-User: string;
```

Allows using the pure header that is expected in the API call.

###### userToUser?

```ts
optional userToUser: string;
```

Transmit user-to-user information if supported by the CC / PBX vendor,
as per RFC 7433.

###### Link

https://tools.ietf.org/html/rfc7433

##### type

```ts
type: "sip";
```

Defined in: [voice/lib/types/Endpoint/SIPEndpoint.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/SIPEndpoint.ts#L8)

Specifies the type of endpoint, which is 'sip' for SIP URIs.

##### uri

```ts
uri: string;
```

Defined in: [voice/lib/types/Endpoint/SIPEndpoint.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/SIPEndpoint.ts#L13)

The SIP URI associated with the endpoint.

***

### ~~SIPEndpointObject~~

```ts
type SIPEndpointObject = SIPEndpoint;
```

Defined in: [voice/lib/interfaces/Endpoint/SIPEndpointObject.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/Endpoint/SIPEndpointObject.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the SIPEndpoint type

***

### ~~SpeechSettings~~

```ts
type SpeechSettings = SpeechSettingsType;
```

Defined in: [voice/lib/interfaces/NCCO/SpeechSettings.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/SpeechSettings.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the SpeechSettingsType type

***

### ~~StreamAction~~

```ts
type StreamAction = StreamActionType;
```

Defined in: [voice/lib/interfaces/NCCO/StreamAction.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/StreamAction.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the StreamActionType type

***

### StreamAudioRequest

```ts
type StreamAudioRequest = object & Omit<StreamAudioParameters, "streamUrl">;
```

Defined in: [voice/lib/types/Requests/StreamAudioRequest.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Requests/StreamAudioRequest.ts#L10)

Represents the parameters for streaming audio during a call.

#### Type declaration

##### stream\_url

```ts
stream_url: string[];
```

An array of stream URLs for the audio source.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

***

### ~~TalkAction~~

```ts
type TalkAction = TalkActionType;
```

Defined in: [voice/lib/interfaces/NCCO/TalkAction.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/NCCO/TalkAction.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the TalkActionType type

***

### TransferCallParameters

```ts
type TransferCallParameters = object;
```

Defined in: [voice/lib/types/Parameters/TransferCallParameters.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/TransferCallParameters.ts#L21)

Represents parameters for transferring a call to another destination.

#### Properties

##### action

```ts
action: "transfer";
```

Defined in: [voice/lib/types/Parameters/TransferCallParameters.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/TransferCallParameters.ts#L25)

The action type indicating a call transfer.

##### destination

```ts
destination: object & XOR<TransferWithURL, TransferWithNCCO>;
```

Defined in: [voice/lib/types/Parameters/TransferCallParameters.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/TransferCallParameters.ts#L30)

The destination of the transfer, which can be specified using NCCO or a URL.

###### Type declaration

###### type

```ts
type: "ncco";
```

The type of destination, either 'ncco' for NCCO-based transfer or 'url' for URL-based transfer.

***

### UnearmuffCallParameters

```ts
type UnearmuffCallParameters = object;
```

Defined in: [voice/lib/types/Parameters/UnearmuffCallParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/UnearmuffCallParameters.ts#L4)

Represents parameters for unearmuffing a call, allowing the call audio to be heard again.

#### Properties

##### action

```ts
action: "unearmuff";
```

Defined in: [voice/lib/types/Parameters/UnearmuffCallParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/UnearmuffCallParameters.ts#L8)

The action type indicating unearmuffing of a call.

***

### UnmuteCallParameters

```ts
type UnmuteCallParameters = object;
```

Defined in: [voice/lib/types/Parameters/UnmuteCallParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/UnmuteCallParameters.ts#L4)

Represents parameters for unmuting a call, allowing audio to be transmitted and received again.

#### Properties

##### action

```ts
action: "unmute";
```

Defined in: [voice/lib/types/Parameters/UnmuteCallParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Parameters/UnmuteCallParameters.ts#L8)

The action type indicating unmuting of a call.

***

### UpdateCallResponse

```ts
type UpdateCallResponse = object;
```

Defined in: [voice/lib/types/Responses/UpdateCallResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/UpdateCallResponse.ts#L8)

Represents the response for updating a call, including a message and the UUID of the call.

#### Remarks

Vonage API's will return information using `snake_case`. This represents the
pure response before the client will transform the keys into `camelCase`.

#### Properties

##### message

```ts
message: string;
```

Defined in: [voice/lib/types/Responses/UpdateCallResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/UpdateCallResponse.ts#L12)

A message associated with the call update response.

##### uuid

```ts
uuid: string;
```

Defined in: [voice/lib/types/Responses/UpdateCallResponse.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Responses/UpdateCallResponse.ts#L17)

The UUID of the call that was updated.

***

### VBCEndpoint

```ts
type VBCEndpoint = object;
```

Defined in: [voice/lib/types/Endpoint/VBCEndpoint.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/VBCEndpoint.ts#L4)

Represents a Vonage Business Cloud (VBC) endpoint, which can be used as a call destination.

#### Properties

##### extension?

```ts
optional extension: string;
```

Defined in: [voice/lib/types/Endpoint/VBCEndpoint.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/VBCEndpoint.ts#L13)

An optional extension associated with the VBC endpoint. If provided, the call will be directed to this extension.

##### type

```ts
type: "vbc";
```

Defined in: [voice/lib/types/Endpoint/VBCEndpoint.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/VBCEndpoint.ts#L8)

Specifies the type of endpoint, which is 'vbc' for Vonage Business Cloud.

***

### ~~VBCEndpointObject~~

```ts
type VBCEndpointObject = VBCEndpoint;
```

Defined in: [voice/lib/interfaces/Endpoint/VBCEndpointObject.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/Endpoint/VBCEndpointObject.ts#L11)

#### Deprecated

This interface is deprecated. Please update to use the VBCEndpoint type

***

### WebsocketEndpoint

```ts
type WebsocketEndpoint = object;
```

Defined in: [voice/lib/types/Endpoint/WebsocketEndpoint.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/WebsocketEndpoint.ts#L4)

Represents a WebSocket endpoint, which can be used as a call destination.

#### Properties

##### contentType?

```ts
optional contentType: string;
```

Defined in: [voice/lib/types/Endpoint/WebsocketEndpoint.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/WebsocketEndpoint.ts#L18)

An optional content type to specify the format of the data sent to the WebSocket endpoint.

##### headers?

```ts
optional headers: Record<string, unknown>;
```

Defined in: [voice/lib/types/Endpoint/WebsocketEndpoint.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/WebsocketEndpoint.ts#L23)

Optional headers to include when connecting to the WebSocket endpoint.

##### type

```ts
type: "websocket";
```

Defined in: [voice/lib/types/Endpoint/WebsocketEndpoint.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/WebsocketEndpoint.ts#L8)

Specifies the type of endpoint, which is 'websocket' for WebSocket.

##### uri

```ts
uri: string;
```

Defined in: [voice/lib/types/Endpoint/WebsocketEndpoint.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/types/Endpoint/WebsocketEndpoint.ts#L13)

The URI (Uniform Resource Identifier) of the WebSocket endpoint.

***

### ~~WebsocketEndpointObject~~

```ts
type WebsocketEndpointObject = WebsocketEndpoint;
```

Defined in: [voice/lib/interfaces/Endpoint/WebsocketEndpointObject.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/voice/lib/interfaces/Endpoint/WebsocketEndpointObject.ts#L12)

#### Deprecated

This interface is deprecated. Please update to use the WebsocketEndpoint type