Skip to main content

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

Interface: Device

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

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:1544

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

base?​

TypeScript
optional base?: string | null;

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

button_template?​

TypeScript
optional button_template?: ButtonTemplate | null;

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

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:1548

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

compatibility?​

TypeScript
optional compatibility?: ButtonCompatibilitySummary;

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

Programmable-key compatibility for the current effective button set.

created_at​

TypeScript
created_at: string;

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

current_ip_address?​

TypeScript
optional current_ip_address?: string | null;

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

display_name?​

TypeScript
optional display_name?: string | null;

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

extensions?​

TypeScript
optional extensions?: HandsetLine[];

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

firmware_version?​

TypeScript
optional firmware_version?: string | null;

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

handsets?​

TypeScript
optional handsets?: DECTHandset[];

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

id​

TypeScript
id: string;

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

ipei?​

TypeScript
optional ipei?: string | null;

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

Absent or null for a kit handset paired to its base at the factory (slot 1) whose IPEI isn't known yet.

last_call_at​

TypeScript
last_call_at: string | null;

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

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:1504

last_registered_at​

TypeScript
last_registered_at: string | null;

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

lines?​

TypeScript
optional lines?: DeviceLine[];

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

location?​

TypeScript
optional location?: string | null;

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

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:1489

max_handsets?​

TypeScript
optional max_handsets?: number | null;

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

model?​

TypeScript
optional model?: string | null;

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

multicell_role?​

TypeScript
optional multicell_role?: DeviceMulticellRole | null;

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

name?​

TypeScript
optional name?: string | null;

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

overrides?​

TypeScript
optional overrides?: DeviceSettings;

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

primary_line?​

TypeScript
optional primary_line?: string | null;

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

registered_at?​

TypeScript
optional registered_at?: string | null;

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

registration_status​

TypeScript
registration_status: DeviceRegistrationStatus;

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

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:1502

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:1539

status​

TypeScript
status: DeviceStatus;

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

type​

TypeScript
type: DeviceType;

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

updated_at​

TypeScript
updated_at: string;

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

vendor​

TypeScript
vendor: string;

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

Auto-detected from the MAC address.

On this page