Skip to main content

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

Interface: QueueCreateParams

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

Properties​

announcements?​

TypeScript
announcements?:
| QueueAnnouncementsConfigInput
| null;

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

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


callback?​

TypeScript
callback?: QueueCallbackConfigInput | null;

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

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


entry_prompt_clip?​

TypeScript
entry_prompt_clip?: string | null;

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

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


exit?​

TypeScript
exit?: QueueTimeout | null;

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

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


exit_key?​

TypeScript
exit_key?: string | null;

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

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


hold_music_clip?​

TypeScript
hold_music_clip?: string | null;

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

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


join_empty?​

TypeScript
join_empty?: string;

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


leave_when_empty?​

TypeScript
leave_when_empty?: string;

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


max_queue_length?​

TypeScript
max_queue_length?: number;

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


name​

TypeScript
name: string;

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


periodic_prompt_clip?​

TypeScript
periodic_prompt_clip?: string | null;

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

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


periodic_prompt_frequency_seconds?​

TypeScript
periodic_prompt_frequency_seconds?: number;

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

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


ring_busy_agents?​

TypeScript
ring_busy_agents?: boolean;

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

Defaults to false.


strategy?​

TypeScript
strategy?: QueueStrategy;

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


timeout?​

TypeScript
timeout?: QueueTimeout | null;

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


timeout_seconds?​

TypeScript
timeout_seconds?: number;

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

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
wrap_up_seconds?: number;

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