Voice | SignalWire

Welcome to version 3 of the RELAY SDK

In May 2022, Voice was incorporated into version 3 of the RELAY Realtime Server SDK. If you have an application that runs on the previous version of RELAY for Voice calls, consider upgrading.

Access the Voice API. You can instantiate a Voice.Client to make or receive calls. Please see Events for the 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 { Voice } from "@signalwire/realtime-api";
2 
3 const client = new Voice.Client({
4   project: "<project-id>",
5   token: "<api-token>",
6   topics: ["office"],
7 });
8 
9 client.on("call.received", async (call) => {
10   console.log("Got call", call.from, call.to);
11 
12   try {
13     await call.answer();
14     console.log("Inbound call answered");
15 
16     await call.playTTS({ text: "Hello! This is a test call." });
17   } catch (error) {
18     console.error("Error answering inbound call", error);
19   }
20 });

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.