Skip to main content

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

Interface: QueueCreateParams

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

Properties​

announcements?​

TypeScript
optional announcements?: 
  | QueueAnnouncementsConfigInput
  | null;

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

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:2590

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:2602

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:2595

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:2593

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:2600

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:2597

leave_when_empty?​

TypeScript
optional leave_when_empty?: string;

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

max_queue_length?​

TypeScript
optional max_queue_length?: number;

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

name​

TypeScript
name: string;

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

periodic_prompt_clip?​

TypeScript
optional periodic_prompt_clip?: string | null;

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

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:2606

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

ring_busy_agents?​

TypeScript
optional ring_busy_agents?: boolean;

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

Defaults to false.

strategy?​

TypeScript
optional strategy?: QueueStrategy;

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

timeout?​

TypeScript
optional timeout?: QueueTimeout | null;

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

timeout_seconds?​

TypeScript
optional timeout_seconds?: number;

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

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:2584

On this page