Skip to content

Interface: IncomingCallEvent ​

Defined in: Calls.types.ts:366

Payload describing one incoming call.

Delivered both inside a VoIP push (parsed natively by the module) and on CallSession.incomingCallEvent for any incoming-origin session.

Properties ​

eventId ​

ts
eventId: string;

Defined in: Calls.types.ts:368

Unique event identifier (UUID). Used for dedup.


serverCallId ​

ts
serverCallId: string;

Defined in: Calls.types.ts:372

Your backend's id for this call. Distinct from CallSession.id, which is the OS-assigned native call UUID. Use this id to talk to your server about the call (e.g. POST /calls/:serverCallId/answer).


hasVideo? ​

ts
optional hasVideo?: boolean;

Defined in: Calls.types.ts:374

True for video calls, false for audio. Defaults to false.


supportsHolding? ​

ts
optional supportsHolding?: boolean;

Defined in: Calls.types.ts:376

Whether the call can be put on hold. See CallOptions.supportsHolding. Defaults to true.


supportsDTMF? ​

ts
optional supportsDTMF?: boolean;

Defined in: Calls.types.ts:378

Whether the call accepts DTMF tones. See CallOptions.supportsDTMF. Defaults to true.


startedAt? ​

ts
optional startedAt?: string;

Defined in: Calls.types.ts:380

RFC 3339 timestamp of when the call was placed. Optional; defaults to now.


caller ​

ts
caller: CallParticipant;

Defined in: Calls.types.ts:382

Caller identity and addressing.


metadata? ​

ts
optional metadata?: Record<string, unknown>;

Defined in: Calls.types.ts:390

App-defined extra fields, forwarded verbatim from the push payload.

The library treats this as opaque — put whatever your app needs here (chatId, tenantId, room name, etc.). Cast to your own type at the read site.