Skip to main content

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

Interface: RingGroup

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

Properties​

confirm_external​

TypeScript
confirm_external: boolean;

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

created_at​

TypeScript
created_at: string;

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

extensions?​

TypeScript
optional extensions?: ListResponse<Extension>;

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

Extensions routing to this ring group. Present only when the request includes expand: ['extensions'].

id​

TypeScript
id: string;

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

ignore_forwarding​

TypeScript
ignore_forwarding: boolean;

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

When true, a SIP 302 redirect (call forwarding) sent by a member's device is ignored: that device is treated as busy and the group keeps ringing its other members. Reaches only forwarding the device performs itself, and applies to every leg the group dials, including devices reached through a member's Find Me / Follow Me. It does not disable Find Me / Follow Me or change which targets that produces.

members​

TypeScript
members: RingGroupMember[];

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

name​

TypeScript
name: string;

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

timeout_action?​

TypeScript
optional timeout_action?: 
  | RingGroupTimeoutAction
  | null;

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

Action when no member answers within timeout_seconds.

timeout_seconds​

TypeScript
timeout_seconds: number;

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

timeout_target?​

TypeScript
optional timeout_target?: string | null;

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

Target the timeout action routes to — a user (user_…), shared voicemail box (svm_…), or queue (qu_…) TypeID, paired with timeout_action.

updated_at​

TypeScript
updated_at: string;

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

On this page