Interface: RingingCallEvent

Event fired once for each user whose phones are about to ring for a call, including calls that reach the user through a ring group or dial plan

Properties

TypeScript
call_id: string;

Call identifier

TypeScript
direction?: "inbound" | "outbound" | "internal";

The call's direction: inbound, outbound or internal (when known)

TypeScript
from_name: string | null;

Caller ID name (if available)

TypeScript
from_number: string;

Caller phone number

TypeScript
ringing_at: Date;

When the user started being rung

TypeScript
timestamp: Date;

When the event was sent

TypeScript
to_number: string;

Called phone number

TypeScript
user: string;

User whose phones are ringing