dial

View as Markdown

dial

  • dial(params): Promise<Call> - See Call for more details.

Create a new outbound call.

This is a generic method that allows you to dial multiple devices in series, parallel, or combinations of both with the use of a DeviceBuilder. For simpler use cases, prefer using dialPhone or dialSip.

Parameters

NameTypeDescription
paramsVoiceDeviceBuilder | { devices: VoiceDeviceBuilder ; region: string }Pass only the Dialer specifying the devices to call or an object with the Dialer and a Region of the world to originate the message from.

Returns

Promise<Call> - See Call for more details.