@dialstack/sdk-dev / server/src / Queue
Interface: Queue
Defined in: sdk/server/src/index.ts:3044
Properties
announcements
announcements: QueueAnnouncementsConfig | null;
Defined in: sdk/server/src/index.ts:3055
Position-announcement config; null when announcements are disabled.
callback
callback: QueueCallbackConfig | null;
Defined in: sdk/server/src/index.ts:3057
Press-1 callback config; null when callbacks are disabled.
created_at
created_at: string;
Defined in: sdk/server/src/index.ts:3097
entry_prompt_clip
entry_prompt_clip: string | null;
Defined in: sdk/server/src/index.ts:3079
Audio clip (aud_...) played once to a caller joining the queue, before
hold music starts. Null when the queue has no entry prompt.
exit
exit: QueueTimeout | null;
Defined in: sdk/server/src/index.ts:3066
Where the caller goes when they press exit_key; null hangs up.
exit_key
exit_key: string | null;
Defined in: sdk/server/src/index.ts:3064
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?
extensions?: ListResponse<Extension>;
Defined in: sdk/server/src/index.ts:3096
Extensions routing to this queue. Present only when the request includes
expand: ['extensions'].
hold_music_clip
hold_music_clip: string | null;
Defined in: sdk/server/src/index.ts:3074
Audio clip (aud_...) played to callers waiting in this queue. Null means
the account's hold music applies.
id
id: string;
Defined in: sdk/server/src/index.ts:3045
join_empty
join_empty: string;
Defined in: sdk/server/src/index.ts:3068
leave_when_empty
leave_when_empty: string;
Defined in: sdk/server/src/index.ts:3069
max_queue_length
max_queue_length: number;
Defined in: sdk/server/src/index.ts:3067
members?
members?: ListResponse<QueueMember>;
Defined in: sdk/server/src/index.ts:3091
The first members of the queue, always embedded and capped at 10. Use
queues.listMembers() for the full, paginated set.
name
name: string;
Defined in: sdk/server/src/index.ts:3046
periodic_prompt_clip
periodic_prompt_clip: string | null;
Defined in: sdk/server/src/index.ts:3084
Audio clip (aud_...) replayed to waiting callers every
periodic_prompt_frequency_seconds. Null when the queue has none.
periodic_prompt_frequency_seconds
periodic_prompt_frequency_seconds: number;
Defined in: sdk/server/src/index.ts:3086
Seconds between plays of periodic_prompt_clip (10-600).
ring_busy_agents
ring_busy_agents: boolean;
Defined in: sdk/server/src/index.ts:3053
Ring members who are on a non-queue call instead of skipping them. Members on a queue call are always skipped.
strategy
strategy: QueueStrategy;
Defined in: sdk/server/src/index.ts:3047
timeout
timeout: QueueTimeout | null;
Defined in: sdk/server/src/index.ts:3058
timeout_seconds
timeout_seconds: number;
Defined in: sdk/server/src/index.ts:3049
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
updated_at: string;
Defined in: sdk/server/src/index.ts:3098
wrap_up_seconds
wrap_up_seconds: number;
Defined in: sdk/server/src/index.ts:3051
Per-agent cooldown after each call (0-600 seconds). 0 disables wrap-up.