Skip to main content

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

Interface: User

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

Properties​

button_template​

TypeScript
button_template:
| string
| ButtonTemplate
| null;

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

The button template shown on whichever phone serves this user, or null when the user has none (the phone's own template is used, else the account's default). An ID, or the full template when the request includes expand: ['button_template'].


config?​

TypeScript
config?: UserConfig;

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


created_at​

TypeScript
created_at: string;

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


do_not_disturb​

TypeScript
do_not_disturb: boolean;

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

Whether server-side do-not-disturb is enabled: when true, the calling path declines calls to this user. Always emitted on responses.


email​

TypeScript
email: string | null;

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


extensions?​

TypeScript
extensions?: ListResponse<Extension>;

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

Extensions assigned to this user. Present only when the request includes expand: ['extensions'].


id​

TypeScript
id: string;

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


location?​

TypeScript
location?: string | null;

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

ID of this user's service location, used for tax jurisdiction and regulatory fees on their seat.

Must agree with the location of any device the user holds: a seat is sourced from its device first, so this either names that same location or is null. A user with no located device resolves to the account's main location. In both cases null is a correct answer, not a missing one.


name​

TypeScript
name: string | null;

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


updated_at​

TypeScript
updated_at: string;

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


voicemail_greeting_clip​

TypeScript
voicemail_greeting_clip: string | null;

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

The audio clip the voicemail greeting plays, or null when the greeting is the system default or an uploaded one. Deleting the clip resets it to null.