Batch Import Devices
API Basic Information
API Description: None
Request method: post
API Request path: /api/v1/cits/devices:batchImport
API Request parameters
Path request parameters
None
Query parameters
None
Request body
| parameter name | type | required | remark |
|---|---|---|---|
| deviceList[] | CreateDeviceRequestPayload | Required | List of devices to be imported |
Response
| parameter name | type | required | remark |
|---|---|---|---|
| deviceList[] | CreateDeviceReponse | Required | Device List |
Related data models
Create Device Response
nexhome.iotdomain.cits.v1.devices.CreateDeviceReponse
| 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 |
| developerId | string | Optional | Devloper ID |
| developerAppId | string | Optional | APP-ID |
| createdTime | integer | Optional | Create time |
| lastModificationTime | integer | Optional | Update Time |
Create Device Body
nexhome.iotdomain.cits.v1.devices.CreateDeviceRequestPayload
| parameter name | type | required | remark |
|---|---|---|---|
| name | string | Required | Device name. |
| position | string | Optional | Device location. |
| type | string | Required | 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 | Required | Device mac |
| sn | string | Optional | Device sn |
| netConfig | DeviceNetConfigRequest | Optional | Network Configuration |
| userConfig | DeviceUserConfigRequest | Optional | User Configuration |
| model | string | Optional | Model |
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 |
| phone | DeviceUserPhoneConfigRequest | Optional | Call Configuration |
Device User Call Configuration
nexhome.iotdomain.cits.v1.devices.DeviceUserPhoneConfigRequest
| parameter name | type | required | remark |
|---|---|---|---|
| callInTimeout | integer | Optional | Maximum incoming call duration, integer, unit: s, 30~120, default 60 |
| callOutTimeout | integer | Optional | Maximum outgoing call duration, integer, unit: s, 15~120, default 60 |
| talkingTimeout | integer | Optional | Call duration, integer, unit minutes, 2~30, default 5 |