Skip to main content

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

Interface: Device

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

A provisioned device — desk phone, DECT base station, or DECT handset. type indicates the kind, and type-specific fields are present only for that kind.

Properties​

assignments?​

TypeScript
optional assignments?: DeviceUserAssignment[];

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

User assignments. Present only when expand: ['users'] is requested.

base?​

TypeScript
optional base?: string | null;

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

button_template?​

TypeScript
optional button_template?: ButtonTemplate | null;

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

The full bound template. Present only when expand: ['button_template'] is requested; the id is always available as button_template_id.

button_template_id?​

TypeScript
optional button_template_id?: string | null;

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

The bound template's id, or null when none is bound.

compatibility?​

TypeScript
optional compatibility?: ButtonCompatibilitySummary;

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

Programmable-key compatibility for the current effective button set.

created_at​

TypeScript
created_at: string;

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

current_ip_address?​

TypeScript
optional current_ip_address?: string | null;

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

display_name?​

TypeScript
optional display_name?: string | null;

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

extensions?​

TypeScript
optional extensions?: HandsetLine[];

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

firmware_version?​

TypeScript
optional firmware_version?: string | null;

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

handsets?​

TypeScript
optional handsets?: DECTHandset[];

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

id​

TypeScript
id: string;

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

ipei?​

TypeScript
optional ipei?: string | null;

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

last_call_at​

TypeScript
last_call_at: string | null;

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

The latest call attempt involving the device, any outcome. Null until its first call: presence means it has carried a call, recency means it is still in use.

last_provisioned_at?​

TypeScript
optional last_provisioned_at?: string | null;

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

last_registered_at​

TypeScript
last_registered_at: string | null;

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

lines?​

TypeScript
optional lines?: DeviceLine[];

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

location?​

TypeScript
optional location?: string | null;

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

Physical E911 location. Set on deskphones and DECT bases; handsets have none of their own and inherit from the paired base, reporting null here.

mac_address​

TypeScript
mac_address: string;

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

max_handsets?​

TypeScript
optional max_handsets?: number | null;

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

model?​

TypeScript
optional model?: string | null;

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

multicell_role?​

TypeScript
optional multicell_role?: DeviceMulticellRole | null;

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

name?​

TypeScript
optional name?: string | null;

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

overrides?​

TypeScript
optional overrides?: DeviceSettings;

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

primary_line?​

TypeScript
optional primary_line?: string | null;

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

registered_at?​

TypeScript
optional registered_at?: string | null;

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

registration_status​

TypeScript
registration_status: DeviceRegistrationStatus;

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

Whether the device is currently reachable, derived live from its assigned lines. Distinct from status, which only reflects whether the device has fetched its configuration. A device with no lines is not_registered.

serial_number?​

TypeScript
optional serial_number?: string;

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

Manufacturer serial number, deskphones and DECT bases only. Omitted until set.

slot_number?​

TypeScript
optional slot_number?: number | null;

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

status​

TypeScript
status: DeviceStatus;

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

type​

TypeScript
type: DeviceType;

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

updated_at​

TypeScript
updated_at: string;

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

vendor​

TypeScript
vendor: string;

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

Auto-detected from the MAC address.

On this page