Skip to main content

@dialstack/sdk / server / ParkedCall

Interface: ParkedCall

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

The call occupying a park slot.

Properties​

call​

TypeScript
call: string | null;

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

The call this parked leg belongs to, or null if no call id was recorded when the call was parked. A null here does not mean the slot is free: an occupant can be present without a recorded call id. parked_call is what says whether the slot is occupied.

from_label​

TypeScript
from_label: string;

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

The parked caller's display name, same vocabulary as a call log's from_label. Passed through as received — a locality or a placeholder like WIRELESS CALLER are both things carriers send, and whether to filter them is left to you.

from_number​

TypeScript
from_number: string;

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

The parked caller's number, same vocabulary as a call log's from_number.

parked_at​

TypeScript
parked_at: string;

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

When the call was parked.

parked_by​

TypeScript
parked_by: string | null;

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

The user who parked the call, or null if no parker id was recorded, which likewise does not mean the slot is free.

parked_by_extension?​

TypeScript
optional parked_by_extension?: string;

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

The extension of the user who parked the call. Carried alongside parked_by so the parker can be identified without a second request. Absent for a user with no extension.

rings_back_at​

TypeScript
rings_back_at: string;

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

When the call rings back to whoever parked it, if nobody retrieves it first. The caller is not disconnected at this moment provided somebody answers the ring-back; if nobody does, the call ends there. Watch status for which happened.

status​

TypeScript
status: "parked" | "ringing_back";

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

'parked' while the caller waits, 'ringing_back' once the park has timed out and the parker's phones are being called. Both are occupied states — the caller stays on hold throughout — so 'ringing_back' is not a slot that has been released. Use this instead of comparing rings_back_at against the clock.

On this page