Skip to main content

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

Interface: CallCreateParams

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

Properties​

dial_string​

TypeScript
dial_string: string;

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

Phone number, extension, or emergency number to dial after the user answers.


did?​

TypeScript
did?: string;

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

Which of the account's numbers to present as caller ID for this one call, as a phone number id. Must be active and outbound-enabled, otherwise the request is rejected. Omit to use the standing caller ID configured for the user, or failing that for the account.

Applies to legs that leave over the carrier. On a call to an internal extension the two parties see the caller's extension, so this has no effect there, but it is still used for any external follow-me leg the call rings on the way to them.


find_me_follow_me_key?​

TypeScript
find_me_follow_me_key?: string;

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

Ring one of the user's alternate Find-Me/Follow-Me ladders for the first leg instead of their primary. Pass the alternate's key.

Omit to use the primary, which is the default; an alternate is never selected implicitly. A key that does not resolve is rejected with a 400 rather than falling back to the primary. Alternates are set under config.find_me_follow_me.alternates on the user.


metadata?​

TypeScript
metadata?: Record<string, string>;

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

Your own string key-value pairs, echoed on the outcome event for this request (call.command_succeeded or call.command_failed). Up to 50 keys; keys up to 40 bytes and values up to 500 bytes, in UTF-8.


user​

TypeScript
user: string;

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

The user whose endpoints ring first; the destination is dialed on answer.