Skip to main content

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

Interface: QueueUpdateParams

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

Properties​

announcements?​

TypeScript
announcements?:
| QueueAnnouncementsConfigInput
| null;

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

Send null to disable announcements; send an object to set/replace the config.


callback?​

TypeScript
callback?: QueueCallbackConfigInput | null;

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

Send null to disable callbacks; send an object to set/replace the config.


entry_prompt_clip?​

TypeScript
entry_prompt_clip?: string | null;

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

Audio clip (aud_...) played once when a caller joins. Send null to remove the prompt; omit to leave unchanged.


exit?​

TypeScript
exit?: QueueTimeout | null;

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

Send null to clear exit behavior (hang up); omit to leave unchanged.


exit_key?​

TypeScript
exit_key?: string | null;

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

Send null so callers can no longer leave early; omit to leave unchanged.


hold_music_clip?​

TypeScript
hold_music_clip?: string | null;

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

Audio clip (aud_...) for this queue's hold music. Send null to fall back to the account's hold music; omit to leave unchanged.


join_empty?​

TypeScript
join_empty?: string;

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


leave_when_empty?​

TypeScript
leave_when_empty?: string;

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


max_queue_length?​

TypeScript
max_queue_length?: number;

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


name?​

TypeScript
name?: string;

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


periodic_prompt_clip?​

TypeScript
periodic_prompt_clip?: string | null;

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

Audio clip (aud_...) replayed to waiting callers. Send null to remove the prompt; omit to leave unchanged.


periodic_prompt_frequency_seconds?​

TypeScript
periodic_prompt_frequency_seconds?: number;

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

Seconds between plays of periodic_prompt_clip (10-600).


ring_busy_agents?​

TypeScript
ring_busy_agents?: boolean;

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


strategy?​

TypeScript
strategy?: QueueStrategy;

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


timeout?​

TypeScript
timeout?: QueueTimeout | null;

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


timeout_seconds?​

TypeScript
timeout_seconds?: number;

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

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.


wrap_up_seconds?​

TypeScript
wrap_up_seconds?: number;

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