Skip to main content

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

Interface: Queue

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

Properties​

announcements​

TypeScript
announcements: QueueAnnouncementsConfig | null;

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

Position-announcement config; null when announcements are disabled.

callback​

TypeScript
callback: QueueCallbackConfig | null;

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

Press-1 callback config; null when callbacks are disabled.

created_at​

TypeScript
created_at: string;

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

entry_prompt_clip​

TypeScript
entry_prompt_clip: string | null;

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

Audio clip (aud_...) played once to a caller joining the queue, before hold music starts. Null when the queue has no entry prompt.

exit​

TypeScript
exit: QueueTimeout | null;

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

Where the caller goes when they press exit_key; null hangs up.

exit_key​

TypeScript
exit_key: string | null;

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

Key a waiting caller presses to leave the queue (0-9 or #). Null means callers cannot leave early. While a press-1 callback offer is open, 1 requests the callback even if it is also the exit key.

extensions?​

TypeScript
optional extensions?: ListResponse<Extension>;

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

Extensions routing to this queue. Present only when the request includes expand: ['extensions'].

hold_music_clip​

TypeScript
hold_music_clip: string | null;

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

Audio clip (aud_...) played to callers waiting in this queue. Null means the account's hold music applies.

id​

TypeScript
id: string;

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

join_empty​

TypeScript
join_empty: string;

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

leave_when_empty​

TypeScript
leave_when_empty: string;

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

max_queue_length​

TypeScript
max_queue_length: number;

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

members?​

TypeScript
optional members?: ListResponse<QueueMember>;

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

The first members of the queue, always embedded and capped at 10. Use queues.listMembers() for the full, paginated set.

name​

TypeScript
name: string;

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

periodic_prompt_clip​

TypeScript
periodic_prompt_clip: string | null;

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

Audio clip (aud_...) replayed to waiting callers every periodic_prompt_frequency_seconds. Null when the queue has none.

periodic_prompt_frequency_seconds​

TypeScript
periodic_prompt_frequency_seconds: number;

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

Seconds between plays of periodic_prompt_clip (10-600).

strategy​

TypeScript
strategy: QueueStrategy;

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

timeout​

TypeScript
timeout: QueueTimeout | null;

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

timeout_seconds​

TypeScript
timeout_seconds: number;

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

How long a caller waits for an agent to answer, 0-3600 seconds (one hour). 0 means the 3600 maximum. A ring already in progress when the wait is up finishes rather than being cut off.

updated_at​

TypeScript
updated_at: string;

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

wrap_up_seconds​

TypeScript
wrap_up_seconds: number;

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

Per-agent cooldown after each call (0-600 seconds). 0 disables wrap-up.

On this page