dial

Initiate a new outbound call. Provide either a url pointing to a SWML document or an inline swml object to control the call flow.

Request

paramsobjectRequired

An object of parameters that will be utilized by the active command.

Response

Call LegobjectRequired

Returned when the call is a standard PSTN, SIP, or WebRTC call.

Fabric Subscriber Device LegobjectRequired

Returned when the call is a Fabric subscriber device leg. The status field is always null for this type.

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const result = await client.calling.dial({
10   from: "+15551234567",
11   to: "+15559876543",
12   url: "https://example.com/call-handler",
13 });
14 console.log(result); // { id: "call-id-xxx", ... }