Function: reportIncomingCall()

function reportIncomingCall(event): Promise<void>;

Defined in: Calls.ts:441

Reports an incoming call to the system.

Call this when you receive a push notification or other signal indicating an incoming call. The system will display the incoming call UI.

Parameters

Parameter	Type	Description
event	IncomingCallEvent	The incoming call event containing caller information.

Returns

Promise<void>

Example

await reportIncomingCall({
  callId: '550e8400-e29b-41d4-a716-446655440000',
  caller: {
    id: 'user-456',
    displayName: 'Jane Smith',
    phoneNumber: '+1234567890',
  },
  hasVideo: false,
  startedAt: new Date(),
});

See

• addIncomingCallReportedListener — fires once the OS accepts the report.
• addCallAnsweredListener — fires when the user answers from the system UI.
• VoIP push payload shape — the payload that drives this when called from a native push handler.