Skip to main content

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

Interface: FMFMAlternate

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

An alternate Find-Me/Follow-Me ladder a call can select by key.

This is not the user's primary ladder. The primary is the find_me_follow_me object these sit on, and is what inbound, queue, ring-group, ring-all and voice-app calls follow; adding alternates changes none of that. An alternate applies only when a call names it — pass its key as find_me_follow_me_key to calls.create().

An alternate carries the same fields as the ladder itself, and cannot hold alternates of its own.

Extends

Properties

confirm_external?

TypeScript
optional confirm_external?: boolean;

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

Require external targets to press a key before connecting. Recommended whenever a step rings a mobile: without it the mobile's carrier voicemail can answer and win the race, connecting the call to that voicemail rather than to the person.

Inherited from

FMFMBase.confirm_external


fallback

TypeScript
fallback: "voicemail" | "target" | "hangup";

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

Inherited from

FMFMBase.fallback


fallback_target?

TypeScript
optional fallback_target?: string;

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

Where to send the call when fallback is target.

Inherited from

FMFMBase.fallback_target


key

TypeScript
key: string;

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

Identifies this alternate in a call. Unique among the ladder's alternates, and yours to choose, so your app can hardcode it rather than store an id.


steps

TypeScript
steps: FMFMStep[];

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

1-5 steps, each with 1-10 targets.

Inherited from

FMFMBase.steps