Create Device
API Basic Information
API Description: None
Request method: post
API Request path: /api/v1/cits/devices
API Request parameters
Path request parameters
None
Query parameters
None
Request body
| parameter name | type | required | remark |
|---|---|---|---|
| name | string | Required | Device name. |
| position | string | Optional | Device location. |
| type | string | Required | Device type. Options: UNSPECIFIED - Unknown. ACCESS - Access device. INTERCOM - Intercom device. INDOOR - Indoor unit. GATEWAY - Edge gateway. IPC - Camera. CENTER - Master station. ROBOT - Robot. SIGNAGE - Door signage |
| brand | string | Optional | Device brand |
| remark | string | Optional | Device remark |
| mac | string | Required | Device mac |
| sn | string | Optional | Device sn |
| netConfig | DeviceNetConfigRequest | Optional | Network Configuration |
| userConfig | DeviceUserConfigRequest | Optional | User Configuration |
| model | string | Optional | Model |
| sipConfig | DeviceSipConfigRequest | Optional | SIP configuration |
| customEncode | string | Optional | Device custom code (from device side) |
| platform | string | Optional | Device platform; default NEXHOME Options: UNSPECIFIED - Unknown. NEXHOME - NEXHOME. HTW - HTW |
Response
| parameter name | type | required | remark |
|---|---|---|---|
| id | integer | Optional | Device ID. |
| iotId | string | Optional | Device IOT ID. |
| productId | string | Optional | Corresponding product ID of the device. |
| name | string | Optional | Device name. |
| position | string | Optional | Device location. |
| type | string | Optional | Device type. Optional values: UNSPECIFIED - Unknown status. ACCESS - Access control device. INTERCOM - Intercom device. INDOOR - Indoor unit. |
| brand | string | Optional | Device brand |
| remark | string | Optional | Device remark |
| mac | string | Optional | Device mac |
| sn | string | Optional | Device sn |
| customEncode | string | Optional | Device custom code |
| platform | string | Optional | Device platform Options: UNSPECIFIED - Unknown. NEXHOME - NEXHOME. HTW - HTW |
| developerId | string | Optional | Devloper ID |
| developerAppId | string | Optional | APP-ID |
| createdTime | integer | Optional | Create time |
| lastModificationTime | integer | Optional | Update Time |
Related data models
Device Network Configuration
nexhome.iotdomain.cits.v1.devices.DeviceNetConfigRequest
| parameter name | type | required | remark |
|---|---|---|---|
| ip | string | Optional | Device IP |
| mask | string | Optional | Subnet mask |
| gateway | string | Optional | Gateway |
| dns | string | Optional | DNS |
Device User Configuration
nexhome.iotdomain.cits.v1.devices.DeviceUserConfigRequest
| parameter name | type | required | remark |
|---|---|---|---|
| language | string | Optional | Language, e.g., en_US, zh_CN, zh_TW, he_IL. |
| timezone | string | Optional | Time zone |
Device SIP Configuration
nexhome.iotdomain.cits.v1.devices.DeviceSipConfigRequest
| parameter name | type | required | remark |
|---|---|---|---|
| transportProtocol | string | Optional | Transport protocol, default TLS Options: UNSPECIFIED - Unknown. UDP - UDP. TCP - TCP. TLS - TLS. |