dial

1
dial(destination, options?): Promise<Call>

Places an outbound call to the given destination.

Waits for authentication before dialing. Media options are merged from saved preferences, destination query parameters (e.g. ?channel=video), and the provided options (highest priority).

Returns a Call in 'ringing' state. Subscribe to Call.status$ to track progression through 'connected' → 'disconnected'.

Parameters

Returns

Promise<Call>

The created Call instance.

Throws

If authentication is not complete or call creation fails.

Examples

1
const call = await client.dial('/public/conference', {
2
  audio: true,
3
  video: true,
4
});
5
call.status$.subscribe(status => console.log('Call:', status));