Function: startOutgoingCall()

function startOutgoingCall(recipient, options): Promise<string>;

Defined in: Calls.ts:381

Starts an outgoing call to the specified recipient.

This requests the system to initiate a call. The system will display the appropriate call UI and emit an OutgoingCallStartedEvent when you should begin connecting your media.

Parameters

Parameter	Type	Description
recipient	CallParticipant	The participant to call.
options	CallOptions	Call configuration options (e.g., video enabled).

Returns

Promise<string>

The unique identifier for this call session.

Example

const callId = await startOutgoingCall(
  { id: 'user-123', displayName: 'John Doe' },
  { hasVideo: true }
);

See

• addOutgoingCallStartedListener for the event fired once the OS accepts the call.
• reportOutgoingCallConnected to call after the remote media stream is established.
• endCall to terminate the call from the app.