Skip to main content

@dialstack/sdk / index / CreateDeviceRequest

Interface: CreateDeviceRequest

Defined in: sdk/src/types/device.ts:313

Request payload for POST /v1/devices. The type field selects which device kind to create; type-specific fields are required as noted.

Properties​

base?​

optional base?: string;

Defined in: sdk/src/types/device.ts:333

Parent DECT base. dect_handset only; omit to stock as unpaired.

base_id?​

optional base_id?: string;

Defined in: sdk/src/types/device.ts:335

Deprecated​

Use base. Retained for backwards compatibility.

ipei?​

optional ipei?: string;

Defined in: sdk/src/types/device.ts:337

Handset IPEI. Required for dect_handset.

location?​

optional location?: string;

Defined in: sdk/src/types/device.ts:342

Physical E911 location. Set on deskphone or dect_base; handsets inherit from their paired base.

location_id?​

optional location_id?: string;

Defined in: sdk/src/types/device.ts:344

Deprecated​

Use location. Retained for backwards compatibility.

mac_address?​

optional mac_address?: string;

Defined in: sdk/src/types/device.ts:323

Hardware MAC address. Required for deskphone and dect_base.

model?​

optional model?: string;

Defined in: sdk/src/types/device.ts:325

Device model (optional, can be auto-detected for deskphones).

multicell_role?​

optional multicell_role?: MulticellRole;

Defined in: sdk/src/types/device.ts:331

Multicell role. dect_base only.

name?​

optional name?: string;

Defined in: sdk/src/types/device.ts:327

Human-friendly label.

overrides?​

optional overrides?: DeviceSettings;

Defined in: sdk/src/types/device.ts:329

Device-specific settings overrides.

type?​

optional type?: DeviceType;

Defined in: sdk/src/types/device.ts:321

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.