@dialstack/sdk-dev / server/src / Device
Interface: Device
Defined in: sdk/server/src/index.ts:1861
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?
assignments?: DeviceUserAssignment[];
Defined in: sdk/server/src/index.ts:1934
User assignments. Present only when expand: ['users'] is requested.
base?
base?: string | null;
Defined in: sdk/server/src/index.ts:1924
button_template?
button_template?: ButtonTemplate | null;
Defined in: sdk/server/src/index.ts:1949
The full bound template. Present only when
expand: ['button_template'] is requested; the id is always available as
button_template_id.
button_template_id?
button_template_id?: string | null;
Defined in: sdk/server/src/index.ts:1943
The bound template's id, or null when none is bound.
Deprecated
A phone shows the layout of the user it serves; see
User.button_template. The device's template is used only when that user
has none.
compatibility?
compatibility?: ButtonCompatibilitySummary;
Defined in: sdk/server/src/index.ts:1936
Programmable-key compatibility for the current effective button set.
created_at
created_at: string;
Defined in: sdk/server/src/index.ts:1908
current_ip_address?
current_ip_address?: string | null;
Defined in: sdk/server/src/index.ts:1878
display_name?
display_name?: string | null;
Defined in: sdk/server/src/index.ts:1928
extensions?
extensions?: HandsetLine[];
Defined in: sdk/server/src/index.ts:1931
firmware_version?
firmware_version?: string | null;
Defined in: sdk/server/src/index.ts:1921
from_hardware_order?
from_hardware_order?: boolean;
Defined in: sdk/server/src/index.ts:1902
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?
handsets?: DECTHandset[];
Defined in: sdk/server/src/index.ts:1918
id
id: string;
Defined in: sdk/server/src/index.ts:1862
ipei?
ipei?: string | null;
Defined in: sdk/server/src/index.ts:1927
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
last_call_at: string | null;
Defined in: sdk/server/src/index.ts:1897
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?
last_provisioned_at?: string | null;
Defined in: sdk/server/src/index.ts:1879
last_registered_at
last_registered_at: string | null;
Defined in: sdk/server/src/index.ts:1886
lines?
lines?: DeviceLine[];
Defined in: sdk/server/src/index.ts:1913
location?
location?: string | null;
Defined in: sdk/server/src/index.ts:1873
Physical E911 location. Deskphones and DECT bases always have one; null only for DECT handsets, which inherit from the paired base.
mac_address
mac_address: string;
Defined in: sdk/server/src/index.ts:1864
max_handsets?
max_handsets?: number | null;
Defined in: sdk/server/src/index.ts:1917
model?
model?: string | null;
Defined in: sdk/server/src/index.ts:1867
multicell_role?
multicell_role?: DeviceMulticellRole | null;
Defined in: sdk/server/src/index.ts:1916
name?
name?: string | null;
Defined in: sdk/server/src/index.ts:1868
offline_since
offline_since: string | null;
Defined in: sdk/server/src/index.ts:1891
When a not_registered device was last registered on its current lines,
or null if it is registered or was never seen online.
overrides?
overrides?: DeviceSettings;
Defined in: sdk/server/src/index.ts:1875
primary_line?
primary_line?: string | null;
Defined in: sdk/server/src/index.ts:1912
registered_at?
registered_at?: string | null;
Defined in: sdk/server/src/index.ts:1930
registration_status
registration_status: DeviceRegistrationStatus;
Defined in: sdk/server/src/index.ts:1885
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?
serial_number?: string;
Defined in: sdk/server/src/index.ts:1877
Manufacturer serial number, deskphones and DECT bases only. Omitted until set.
slot_number?
slot_number?: number | null;
Defined in: sdk/server/src/index.ts:1929
status
status: DeviceStatus;
Defined in: sdk/server/src/index.ts:1874
type
type: DeviceType;
Defined in: sdk/server/src/index.ts:1863
updated_at
updated_at: string;
Defined in: sdk/server/src/index.ts:1909
vendor
vendor: string;
Defined in: sdk/server/src/index.ts:1866
Auto-detected from the MAC address.
zero_touch_escalation?
zero_touch_escalation?:
| DeviceZeroTouchEscalation
| null;
Defined in: sdk/server/src/index.ts:1907
The device's open zero-touch provisioning escalation; null when none is open. Deskphones and DECT bases only.