@dialstack/sdk-dev / js/src / CreateDeviceRequest
Interface: CreateDeviceRequest
Defined in: sdk/js/src/types/device.ts:395
Request payload for POST /v1/devices. The type field selects which
device kind to create; type-specific fields are required as noted.
Properties
base?
base?: string;
Defined in: sdk/js/src/types/device.ts:415
Parent DECT base. dect_handset only; omit to stock as unpaired.
base_id?
base_id?: string;
Defined in: sdk/js/src/types/device.ts:417
Deprecated
Use base. Retained for backwards compatibility.
ipei?
ipei?: string;
Defined in: sdk/js/src/types/device.ts:419
Handset IPEI. Required for dect_handset.
location?
location?: string;
Defined in: sdk/js/src/types/device.ts:428
Physical E911 location. Set on deskphone or dect_base; handsets
inherit from their paired base. When omitted, the device gets the
account's only location, else its main location. That default is a real
location: before assigning a user seated at another location, set the
device's location to that site, or the assignment is refused with
location_conflict.
location_id?
location_id?: string;
Defined in: sdk/js/src/types/device.ts:430
Deprecated
Use location. Retained for backwards compatibility.
mac_address?
mac_address?: string;
Defined in: sdk/js/src/types/device.ts:405
Hardware MAC address. Required for deskphone and dect_base.
model?
model?: string;
Defined in: sdk/js/src/types/device.ts:407
Device model (optional, can be auto-detected for deskphones).
multicell_role?
multicell_role?: MulticellRole;
Defined in: sdk/js/src/types/device.ts:413
Multicell role. dect_base only.
name?
name?: string;
Defined in: sdk/js/src/types/device.ts:409
Human-friendly label.
overrides?
overrides?: DeviceSettings;
Defined in: sdk/js/src/types/device.ts:411
Device-specific settings overrides.
type?
type?: DeviceType;
Defined in: sdk/js/src/types/device.ts:403
Device kind to create. Optional for MAC-addressable devices: omit it and
the type is detected from mac_address via the vendor product catalog.
The request is rejected with 400 if the MAC can't be classified, or if a
supplied type contradicts a positive catalog match. dect_handset is
IPEI-identified and must always be supplied.