Interface VoiceCall

Interface for controlling voice calls with mute, hold, disconnect, and recording capabilities.

interface VoiceCall {
    disconnect(): Promise<void>;
    hold(options?: HoldCallOptions): Promise<Task>;
    isMuted(): undefined | boolean;
    isOnHold(): Promise<boolean>;
    mute(): void;
    pauseRecording(pauseBehaviour?: "silence" | "skip"): Promise<void>;
    resumeRecording(): Promise<void>;
    unhold(): Promise<Task>;
    unmute(): void;
}

Index

Methods

disconnect hold isMuted isOnHold mute pauseRecording resumeRecording unhold unmute

Methods

disconnect

disconnect(): Promise<void>

Hang up current call (if there is one).

Returns Promise<void>

Throws

FlexSdkError with the following error code(s):

Example

import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);

await voiceCall.disconnect();

hold

hold(options?: HoldCallOptions): Promise<Task>
Hold current call (if there is one).
Parameters
- Optionaloptions: HoldCallOptions
  Options to specify hold music URL and HTTP method
Returns Promise<Task>
- A promise that resolves to a Task object, representing the held task.
Throws
FlexSdkError with the following error code(s):
Example
```
import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);

await voiceCall.hold({ holdMusicUrl: "holdMusicUrl", holdMusicMethod: "GET" });
```

isMuted

isMuted(): undefined | boolean

Is current call muted

Returns undefined | boolean

A boolean indicating whether the call is muted

Throws

FlexSdkError with the following error code(s):

ErrorCode.CallInstanceUndefined

Example

import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);

const isMuted: boolean = voiceCall.isMuted();
console.log(`Call ${isMuted ? "is muted" : "is not muted"}`)

isOnHold

isOnHold(): Promise<boolean>

Check if current call (if there is one) is on hold.

Returns Promise<boolean>

A promise that resolves to a boolean indicating whether the call is on hold.

Throws

FlexSdkError with the following error code(s):

Example

import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);

const isOnHold: boolean = await voiceCall.isOnHold();
console.log(`Call ${isOnHold ? "is on hold" : "is not on hold"}`)

mute

mute(): void

Mute current call

Returns void

Throws

FlexSdkError with the following error code(s):

ErrorCode.CallInstanceUndefined

Example

import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);
voiceCall.mute();

const isMuted: boolean = voiceCall.isMuted();
console.log(`Call ${isMuted ? "is muted" : "is not muted"}`)

pauseRecording

pauseRecording(pauseBehaviour?: "silence" | "skip"): Promise<void>
Pause recording current conference (if there is one).
Parameters
- OptionalpauseBehaviour: "silence" | "skip"
  The behaviour to use when pausing the recording. Can be either "silence" or "skip". Default is "silence".
Returns Promise<void>
Throws
FlexSdkError with the following error code(s):
Example
```
import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX");

const voiceCall = await client.execute(startOutboundCall);

await voiceCall.pauseRecording("silence");
```

resumeRecording

resumeRecording(): Promise<void>
Resume recording current conference. This method will only resume an existing recording, it won't start a new one.

Returns Promise<void>
Throws
FlexSdkError with the following error code(s):
Example
```
import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX");

const voiceCall = await client.execute(startOutboundCall);

await voiceCall.resumeRecording();
```

unhold

unhold(): Promise<Task>

Unhold current call (if there is one).

Returns Promise<Task>

A promise that resolves to a Task object, representing the unheld task.

Throws

FlexSdkError with the following error code(s):

Example

import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);

// Call is not on hold by default so to unhold, it is needed to hold first
await call.hold("holdMusicUrl", "GET");
await call.unhold();

unmute

unmute(): void

Unmute current call

Returns void

Throws

FlexSdkError with the following error code(s):

ErrorCode.CallInstanceUndefined

Example

import { createClient, StartOutboundCall } from "@twilio/flex-sdk";

const client = await createClient("SDK_TOKEN");
const startOutboundCall = new StartOutboundCall("+1XXX", { fromNumber: "+1XXX", workflowSid: "WWXXX", taskQueueSid: "WQXXX"});

const voiceCall = await client.execute(startOutboundCall);
voiceCall.unmute();

const isMuted: boolean = voiceCall.isMuted();
console.log(`Call ${isMuted ? "is muted" : "is not muted"}`)

Interface VoiceCall

Index

Methods

Methods

disconnect

Returns Promise<void>

Throws

Example

hold

Parameters

Returns Promise<Task>

Throws

Example

isMuted

Returns undefined | boolean

Throws

Example

isOnHold

Returns Promise<boolean>

Throws

Example

mute

Returns void

Throws

Example

pauseRecording

Parameters

Returns Promise<void>

Throws

Example

resumeRecording

Returns Promise<void>

Throws

Example

unhold

Returns Promise<Task>

Throws

Example

unmute

Returns void

Throws

Example

Settings

On This Page