Skip to content

Function: reportIncomingCall() ​

ts
function reportIncomingCall(event): Promise<void>;

Defined in: Calls.ts:442

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 ​

ParameterTypeDescription
eventIncomingCallEventThe incoming call event containing caller information.

Returns ​

Promise<void>

Example ​

typescript
await reportIncomingCall({
  eventId: '550e8400-e29b-41d4-a716-446655440000',
  serverCallId: 'srv-abc-123',
  caller: {
    id: 'user-456',
    displayName: 'Jane Smith',
    phoneNumber: '+1234567890',
  },
  hasVideo: false,
  startedAt: '2026-01-15T19:42:11.000Z',
});

See ​