Skip to main content

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

Interface: QueueUpdateParams

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

Properties

announcements?

TypeScript
optional announcements?:
| QueueAnnouncementsConfigInput
| null;

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

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


callback?

TypeScript
optional callback?: QueueCallbackConfigInput | null;

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

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


entry_prompt_clip?

TypeScript
optional entry_prompt_clip?: string | null;

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

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


hold_music_clip?

TypeScript
optional hold_music_clip?: string | null;

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

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
optional join_empty?: string;

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


leave_when_empty?

TypeScript
optional leave_when_empty?: string;

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


max_queue_length?

TypeScript
optional max_queue_length?: number;

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


name?

TypeScript
optional name?: string;

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


periodic_prompt_clip?

TypeScript
optional periodic_prompt_clip?: string | null;

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

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


periodic_prompt_frequency_seconds?

TypeScript
optional periodic_prompt_frequency_seconds?: number;

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

Seconds between plays of periodic_prompt_clip (10-600).


strategy?

TypeScript
optional strategy?: QueueStrategy;

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


timeout?

TypeScript
optional timeout?: QueueTimeout | null;

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


timeout_seconds?

TypeScript
optional timeout_seconds?: number;

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

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

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