Skip to main content

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

Interface: QueueCreateParams

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

Properties​

announcements?​

TypeScript
optional announcements?: 
  | QueueAnnouncementsConfigInput
  | null;

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

Provide an object to enable announcements; omit or set null to disable.

callback?​

TypeScript
optional callback?: QueueCallbackConfigInput | null;

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

Provide an object to enable callbacks; omit or set null to disable.

entry_prompt_clip?​

TypeScript
optional entry_prompt_clip?: string | null;

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

Audio clip (aud_...) played once when a caller joins, before hold music.

exit?​

TypeScript
optional exit?: QueueTimeout | null;

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

Where the caller goes when they press exit_key; omit or set null to hang up.

exit_key?​

TypeScript
optional exit_key?: string | null;

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

Key a waiting caller presses to leave (0-9 or #); omit or set null to disallow.

hold_music_clip?​

TypeScript
optional hold_music_clip?: string | null;

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

Audio clip (aud_...) for this queue's hold music; omit to use the account's.

join_empty?​

TypeScript
optional join_empty?: string;

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

leave_when_empty?​

TypeScript
optional leave_when_empty?: string;

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

max_queue_length?​

TypeScript
optional max_queue_length?: number;

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

name​

TypeScript
name: string;

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

periodic_prompt_clip?​

TypeScript
optional periodic_prompt_clip?: string | null;

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

Audio clip (aud_...) replayed to waiting callers.

periodic_prompt_frequency_seconds?​

TypeScript
optional periodic_prompt_frequency_seconds?: number;

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

Seconds between plays of periodic_prompt_clip (10-600; default 60).

strategy?​

TypeScript
optional strategy?: QueueStrategy;

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

timeout?​

TypeScript
optional timeout?: QueueTimeout | null;

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

timeout_seconds?​

TypeScript
optional timeout_seconds?: number;

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

How long a caller waits for an agent to answer, 0-3600 seconds (one hour). Defaults to 300. 0 means the 3600 maximum.

wrap_up_seconds?​

TypeScript
optional wrap_up_seconds?: number;

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

On this page