Voice | SignalWire

Access the Voice API. You can instantiate a Voice.Client to make or receive calls.

Refer to Events for a full list of events emitted by a Voice.Client object.

Example

The following example answers any call in the office topic, and immediately plays some speech.

1 import { SignalWire } from "@signalwire/realtime-api";
2 
3 const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4 
5 await client.voice.listen({
6   topics: ["office"],
7   onCallReceived: (call) => {
8     call.answer();
9     call.playTTS({ text: "Hello world" });
10   }
11 });

Classes

Call

Represents an active voice call with methods for playback, recording, speech detection, and call control.

CallCollect

Represents a collect operation for gathering user input via DTMF or speech during a call.

CallDetect

Represents a detect operation for identifying answering machines, fax tones, or digits during a call.

CallPlayback

Represents a playback operation for playing audio, TTS, silence, or ringtones during a call.

CallPrompt

Represents a prompt operation that combines playback with input collection during a call.

CallRecording

Represents a recording operation for capturing audio during a call.

CallState

Represents the state of a call with properties for tracking call progress and status.

CallTap

Represents a tap operation for streaming call audio to an external destination.

Client

The main Voice client for making outbound calls and listening for inbound call events.

DeviceBuilder

Helper class for building device configurations when dialing multiple endpoints.

Playlist

Helper class for building playlists of audio, TTS, silence, and ringtones for playback.