Skip to main content

@dialstack/sdk-dev / server/src / CallLog

Interface: CallLog

Defined in: sdk/server/src/index.ts:1079

Record of a completed or attempted call. The id is an opaque call log identifier — one call log may span several underlying legs, so it does not correspond to any single leg.

The record is lifecycle-spanning: it can be retrieved while the call is still live, in which case it is a sparse projection. status, to_label, ended_at, duration_seconds, answered_at, connected_at, hangup_cause, summary, and recording_url are null until the call completes, and quality_metrics is empty. to_number is present live for outbound and internal calls but null for inbound ones, whose routed destination is resolved later.

Properties​

answered_at​

TypeScript
answered_at: string | null;

Defined in: sdk/server/src/index.ts:1129

When the call was answered at the signalling level. A greeting, menu, or voice app answering the media path counts, so for inbound calls this is often the platform answer rather than when a person picked up — use connected_at for that.


connected_at​

TypeScript
connected_at: string | null;

Defined in: sdk/server/src/index.ts:1136

When the call connected: a user's device or an external number answered, or a voice app took it with attach or bridge. Null when the call never connected (abandoned during the greeting or while ringing) or was answered by voicemail.


did​

TypeScript
did: string | DIDSummary | null;

Defined in: sdk/server/src/index.ts:1088

The phone number associated with this call — its id by default, or a compact DIDSummary when expand: ['did'] is requested. Null for calls without a DID.


direction​

TypeScript
direction: CallDirection;

Defined in: sdk/server/src/index.ts:1111


duration_seconds​

TypeScript
duration_seconds: number | null;

Defined in: sdk/server/src/index.ts:1138


ended_at​

TypeScript
ended_at: string | null;

Defined in: sdk/server/src/index.ts:1137


endpoint​

TypeScript
endpoint: string | null;

Defined in: sdk/server/src/index.ts:1082


from_label​

TypeScript
from_label: string | null;

Defined in: sdk/server/src/index.ts:1119

The caller's display name, or null when none is available. For external callers this is the raw CNAM, which may be a locality ("LA MESA CA"), a placeholder ("WIRELESS CALLER"), or a restatement of from_number — check for the latter before rendering it beside the number.


from_number​

TypeScript
from_number: string;

Defined in: sdk/server/src/index.ts:1112


hangup_cause​

TypeScript
hangup_cause: number | null;

Defined in: sdk/server/src/index.ts:1142

Q.850 hangup cause of the destination leg when the call couldn't connect.


id​

TypeScript
id: string;

Defined in: sdk/server/src/index.ts:1080


quality_metrics​

TypeScript
quality_metrics: QualityMetricLeg[];

Defined in: sdk/server/src/index.ts:1147


recording_url​

TypeScript
recording_url: string | null;

Defined in: sdk/server/src/index.ts:1146

Signed recording download URL, valid for 10 minutes.


TypeScript
related_call: string | null;

Defined in: sdk/server/src/index.ts:1110

Another call belonging to the same conversation, as a call id; null when this call stands alone.

One conversation does not always fit in one call log. Today that happens when a parked caller is picked back up — the retrieval is a new call from the retriever's endpoint and gets its own entry — but treat the field as "there is more of this conversation over there" rather than as a park-specific marker.

It carries no direction. started_at orders a linked group, and its earliest member is the one the conversation started on; follow the links to walk a longer chain. The relation can be many-to-one, so the link does not always round-trip to the entry you came from.


remote_number​

TypeScript
remote_number: string | RemoteNumber | null;

Defined in: sdk/server/src/index.ts:1094

The external party in E.164: the caller on an inbound call, the number dialed on an outbound one. The RemoteNumber with expand: ['remote_number']. Null on internal and emergency calls.


sentiment?​

TypeScript
sentiment?: Sentiment | null;

Defined in: sdk/server/src/index.ts:1144


started_at​

TypeScript
started_at: string;

Defined in: sdk/server/src/index.ts:1122


status​

TypeScript
status: CallStatus | null;

Defined in: sdk/server/src/index.ts:1140

Final status, derived once the call ends. Null while the call is live.


summary​

TypeScript
summary: string | null;

Defined in: sdk/server/src/index.ts:1143


to_label​

TypeScript
to_label: string | null;

Defined in: sdk/server/src/index.ts:1121


to_number​

TypeScript
to_number: string | null;

Defined in: sdk/server/src/index.ts:1120


user​

TypeScript
user: string | null;

Defined in: sdk/server/src/index.ts:1081