Skip to main content

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

Interface: Device

Defined in: sdk/js/src/types/device.ts:78

A device returned by GET /v1/devices or GET /v1/devices/:id. The type field discriminates between deskphones and DECT bases. Type-specific fields are present only for the corresponding type.

Use the isDeskphone() and isDECTBase() type guards for safe narrowing.

Properties​

assignments?​

TypeScript
assignments?: DeviceUserAssignment[];

Defined in: sdk/js/src/types/device.ts:171

User assignments (deskphones and DECT handsets). Only hydrated when the device is fetched with expand[]=users; absent otherwise. DECT bases always carry an empty array — handsets, not bases, are user-assigned.


button_template?​

TypeScript
button_template?: string | null;

Defined in: sdk/js/src/types/device.ts:112

Reusable programmable-key template bound to this device.


button_template_id?​

TypeScript
button_template_id?: string | null;

Defined in: sdk/js/src/types/device.ts:114

Deprecated​

Use button_template. Retained for backwards compatibility.


compatibility?​

TypeScript
compatibility?: ButtonCompatibilitySummary;

Defined in: sdk/js/src/types/device.ts:190

Programmable-key compatibility for the current effective button set.


created_at​

TypeScript
created_at: string;

Defined in: sdk/js/src/types/device.ts:162

ISO 8601 timestamp


current_ip_address?​

TypeScript
current_ip_address?: string;

Defined in: sdk/js/src/types/device.ts:120

Last known IP address from provisioning request


firmware_version?​

TypeScript
firmware_version?: string;

Defined in: sdk/js/src/types/device.ts:127

Firmware version named in the User-Agent of the last recognized config fetch. A fetch with an unrecognized User-Agent keeps the previous value.


from_hardware_order?​

TypeScript
from_hardware_order?: boolean;

Defined in: sdk/js/src/types/device.ts:155

Whether the device was shipped in one of the platform's hardware orders, rather than brought by the customer. Deskphones and DECT bases only.


handsets?​

TypeScript
handsets?: DECTHandset[];

Defined in: sdk/js/src/types/device.ts:187

Associated handsets (when eager-loaded)


id​

TypeScript
id: string;

Defined in: sdk/js/src/types/device.ts:80

Unique identifier for the device (a deskphone or a DECT base)


last_call_at​

TypeScript
last_call_at: string | null;

Defined in: sdk/js/src/types/device.ts:144

ISO 8601 timestamp of the latest call attempt involving the device (any outcome), or null until its first call. Presence means the device has carried a call; recency indicates whether it is still in use.


last_provisioned_at?​

TypeScript
last_provisioned_at?: string;

Defined in: sdk/js/src/types/device.ts:122

ISO 8601 timestamp of last successful config fetch


last_registered_at​

TypeScript
last_registered_at: string | null;

Defined in: sdk/js/src/types/device.ts:138

ISO 8601 timestamp of when reachability was last confirmed; null when the device is not currently reachable.


lines?​

TypeScript
lines?: DeviceLine[];

Defined in: sdk/js/src/types/device.ts:179

Configured lines on this device


location?​

TypeScript
location?: string | null;

Defined in: sdk/js/src/types/device.ts:108

Physical E911 location for this device. Deskphones and DECT bases always have one; null only for DECT handsets. DECT handsets have no location_id of their own — they inherit from the paired base and the handset response carries null here.


location_id?​

TypeScript
location_id?: string | null;

Defined in: sdk/js/src/types/device.ts:110

Deprecated​

Use location. Retained for backwards compatibility.


mac_address​

TypeScript
mac_address: string;

Defined in: sdk/js/src/types/device.ts:84

Hardware MAC address (e.g., "00:04:13:aa:bb:cc")


max_handsets?​

TypeScript
max_handsets?: number;

Defined in: sdk/js/src/types/device.ts:185

Maximum number of handsets this base supports


model?​

TypeScript
model?: string;

Defined in: sdk/js/src/types/device.ts:94

Device model (e.g., "D785", "M700")


multicell_role?​

TypeScript
multicell_role?: MulticellRole;

Defined in: sdk/js/src/types/device.ts:183

Role in multicell deployment


name?​

TypeScript
name?: string | null;

Defined in: sdk/js/src/types/device.ts:101

Human-friendly label for the device. Set by admins on deskphones, DECT bases, and DECT handsets; null when unassigned. (Handset responses also expose this value as display_name for backwards compatibility with the legacy DECT API.)


offline_since?​

TypeScript
offline_since?: string | null;

Defined in: sdk/js/src/types/device.ts:150

For a not_registered device, ISO 8601 timestamp of when it was last seen online (its last registration refresh). null while registered, and for a device never seen online.


overrides?​

TypeScript
overrides?: DeviceSettings;

Defined in: sdk/js/src/types/device.ts:118

Device-specific settings overrides


primary_line?​

TypeScript
primary_line?: string;

Defined in: sdk/js/src/types/device.ts:175

ID of the primary line


primary_line_id?​

TypeScript
primary_line_id?: string;

Defined in: sdk/js/src/types/device.ts:177

Deprecated​

Use primary_line. Retained for backwards compatibility.


registration_status​

TypeScript
registration_status: RegistrationStatus;

Defined in: sdk/js/src/types/device.ts:133

Whether the device is currently reachable (online). Live-derived from the device's assigned lines; distinct from status, which only reflects whether the device has fetched its config. Always present.


serial_number?​

TypeScript
serial_number?: string;

Defined in: sdk/js/src/types/device.ts:90

Manufacturer serial number from the device label, used to resolve zero-touch provisioning transfers. deskphone and dect_base only; omitted when not set.


status​

TypeScript
status: DeviceStatus;

Defined in: sdk/js/src/types/device.ts:116

Current provisioning status


type​

TypeScript
type: DeviceType;

Defined in: sdk/js/src/types/device.ts:82

Device type discriminator


updated_at​

TypeScript
updated_at: string;

Defined in: sdk/js/src/types/device.ts:164

ISO 8601 timestamp


vendor​

TypeScript
vendor: string;

Defined in: sdk/js/src/types/device.ts:92

Detected vendor (e.g., "snom", "yealink")


zero_touch_escalation?​

TypeScript
zero_touch_escalation?: DeviceZeroTouchEscalation | null;

Defined in: sdk/js/src/types/device.ts:160

The device's open zero-touch provisioning escalation; null when none is open. Deskphones and DECT bases only.