View Device Details
API Basic Information
API Description: None
Request method: get
API Request path: /api/v1/cits/devices/{iotId}
API Request parameters
Path request parameters
| parameter name | type | required | remark |
|---|---|---|---|
| iotId | string | Required | Device iotId |
Query parameters
| parameter name | type | required | remark |
|---|---|---|---|
| needRealtime | boolean | Optional | Whether to read from device in real time (to fetch extra space/SIP info on edge). Default false, read from cloud cache |
Request body
None
Response
| parameter name | type | required | remark |
|---|---|---|---|
| device | DeviceDto | Optional | Device information |
| netConfig | DeviceNetConfigDto | Optional | Network Configuration |
| userConfig | DeviceUserConfigDto | Optional | User Configuration |
| sipInfo | DeviceSipConfigDto | Optional | Device SIP information (returned by cloud intercom device) |
| qrcodeAccessSecret | DeviceQrcodeAccessSecretConfigDto | Optional | Device QR code access key (returned by access control or intercom devices) |
Related data models
Device
nexhome.iotdomain.cits.v1.devices.DeviceDto
| 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. 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 | Optional | Device mac |
| ip | string | Optional | Device IP |
| mask | string | Optional | Subnet mask |
| gateway | string | Optional | Gateway |
| dns | string | Optional | DNS |
| softVersion | string | Optional | Software version |
| softVersionCode | integer | Optional | Software version code |
| hardVersion | string | Optional | Hardware version |
| onlineStatus | string | Optional | Online status, UNSPECIFIED (unknown)/ONLINE (online)/OFFLINE (offline) Optional values: UNSPECIFIED - Unknown state. ONLINE - Online. OFFLINE - Offline. |
| lastOnlineTime | integer | Optional | Last online timestamp (milliseconds) |
| sn | string | Optional | Device sn |
| sipNumber | string | Optional | Device SIP number (returned for intercom devices) |
| model | string | Optional | Model |
| cover | string | Optional | Device cover file key (currently only for IPC devices). Call /api/v1/cits/devices/{iot_id}/files:generateOssUrl to obtain URL |
| gatewayIotId | string | Optional | Parent device IoT ID (returned when querying sub-devices) |
| spaceId | string | Optional | Space ID (returned when querying sub-devices from edge) |
| spaceName | string | Optional | Space full name (returned when querying sub-devices from edge) |
| spaceLayer | integer | Optional | Space layer (returned when querying sub-devices from edge) |
| developerId | string | Optional | Devloper ID |
| developerAppId | string | Optional | APP-ID |
| createdTime | integer | Optional | Create time |
| lastModificationTime | integer | Optional | Update Time |
Device Network Configuration
nexhome.iotdomain.cits.v1.devices.DeviceNetConfigDto
| parameter name | type | required | remark |
|---|---|---|---|
| ip | string | Optional | Device IP |
| mask | string | Optional | Subnet mask |
| gateway | string | Optional | Gateway |
| dns | string | Optional | DNS |
| status | string | Optional | Status, options: UNSPECIFIED - Unknown status. ALL_DISTRIBUTED - All synchronized. NOT_ALL_DISTRIBUTED - Not all synchronized. |
| failedReason | string | Optional | Reason for failure |
| failedCode | string | Optional | Failure error code |
Device User Configuration
nexhome.iotdomain.cits.v1.devices.DeviceUserConfigDto
| parameter name | type | required | remark |
|---|---|---|---|
| language | string | Optional | Time zone |
| timezone | string | Optional | Language, e.g., en_US, zh_CN, zh_TW, he_IL. |
| status | string | Optional | Status, options: UNSPECIFIED - Unknown status. ALL_DISTRIBUTED - All synchronized. NOT_ALL_DISTRIBUTED - Not all synchronized. |
| failedReason | string | Optional | Reason for failure |
| failedCode | string | Optional | Failure error code |
Device SIP Configuration
nexhome.iotdomain.cits.v1.devices.DeviceSipConfigDto
| parameter name | type | required | remark |
|---|---|---|---|
| sipNumber | string | Optional | SIP Number |
| password | string | Optional | SIP password |
| serverHost | string | Optional | SIP server address |
| serverPort | integer | Optional | SIP server port |
| status | string | Optional | Status Options: UNSPECIFIED - Unknown. SYNC_ING - Processing. SYNC_FAIL - Failed. SYNC_SUCCESS - Success. |
| failedReason | string | Optional | Reason for failure |
| failedCode | string | Optional | Failure error code |
**Device QR code access key **
nexhome.iotdomain.cits.v1.devices.DeviceQrcodeAccessSecretConfigDto
| parameter name | type | required | remark |
|---|---|---|---|
| secret | string | Optional | Secret key |
| status | string | Optional | Status Options: UNSPECIFIED - Unknown. SYNC_ING - Processing. SYNC_FAIL - Failed. SYNC_SUCCESS - Success. |
| failedReason | string | Optional | Reason for failure |
| failedCode | string | Optional | Failure error code |