Calling | SignalWire

The Calling resource provides REST-based call control through the RestClient. All 37 commands are dispatched as POST requests to a single endpoint (/api/calling/calls) with a command field identifying the operation.

Access via client.calling on a RestClient instance.

Every method takes the call ID first, then any required command fields as positional arguments, then an optional options object for the remaining fields. The options object also accepts extras, a bag of additional fields merged into the command as-is. A final optional requestOptions argument sets the timeout, retries, and abort signal for that one request.

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const call = await client.calling.dial("+15551234567", "+15559876543", {
  url: "https://example.com/call-handler",
});
const controlId = "greeting-1";
await client.calling.play(call.id, [{ type: "tts", params: { text: "Hello!" } }], { control_id: controlId });
await client.calling.playStop(call.id, controlId);
await client.calling.end(call.id, { reason: "hangup" });

Unlike the Relay client which uses persistent WebSocket connections, the Calling namespace sends each command as an independent HTTP request. This is suitable for server-side orchestration where you do not need real-time event streams.

Methods

Call Lifecycle

dial

Initiate a new outbound call via REST.

update

Update parameters on an active call via REST.

end

End an active call via REST.

Call Control

transfer

Transfer an active call to a new destination via REST.

disconnect

Disconnect (unbridge) a connected call without ending either leg via REST.

Media and Playback

play

Play audio or text-to-speech on an active call via REST.

playPause

Pause an active playback on a call via REST.

playResume

Resume a paused playback on a call via REST.

playStop

Stop an active playback on a call via REST.

playVolume

Adjust the volume of an active playback on a call via REST.

Recording

record

Start recording an active call via REST.

recordPause

Pause an active recording on a call via REST.

recordResume

Resume a paused recording on a call via REST.

recordStop

Stop an active recording on a call via REST.

Input Collection

collect

Collect user input (DTMF or speech) on an active call via REST.

collectStop

Stop an active input collection on a call via REST.

collectStartInputTimers

Manually start input timers for a collection on a call via REST.

Detection

detect

Start detection (answering machine, fax, DTMF) on a call via REST.

detectStop

Stop an active detector on a call via REST.

Audio Tap

tap

Tap call audio to an external endpoint via REST.

tapStop

Stop an active audio tap on a call via REST.

Audio Streaming

stream

Stream call audio to a WebSocket endpoint via REST.

streamStop

Stop an active audio stream on a call via REST.

Noise Reduction

denoise

Enable noise reduction on an active call via REST.

denoiseStop

Disable noise reduction on an active call via REST.

Transcription and Translation

transcribe

Start transcribing speech on an active call via REST.

transcribeStop

Stop an active transcription on a call via REST.

liveTranscribe

Start live transcription with partial results on a call via REST.

liveTranslate

Start live translation on an active call via REST.

AI Session Control

aiMessage

Send a message to an active AI session on a call via REST.

aiHold

Put an active AI session on hold via REST.

aiUnhold

Resume a held AI session on a call via REST.

aiStop

Stop an active AI session on a call via REST.

Fax

sendFaxStop

Stop an in-progress fax send operation on a call via REST.

receiveFaxStop

Stop an in-progress fax receive operation on a call via REST.

SIP

refer

Send a SIP REFER to transfer a call at the SIP level via REST.

Custom Events

userEvent

Send custom user-defined events on an active call via REST.