用户设备
2026/11/3大约 3 分钟
用户设备
App 用户与平台设备的绑定关系(绑定后才可在 App 中查看与控制设备)。前缀:/app-api/iot/app-user-device,均需登录态。
绑定设备(扫二维码/序列号)
| 方法 | 接口地址 |
|---|---|
| POST | /app-api/iot/app-user-device/create |
请求参数
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| deviceId | 设备id(通过「查找设备」接口获得) | true | long |
| name | 用户自定义设备名 | false | string |
| userRemark | 用户备注 | false | string |
| uuid | 分享绑定的标识(扫分享码绑定时传入) | false | string |
响应参数:
data为绑定记录id(long)
绑定流程:扫码/输入序列号得到 deviceName → GET /find/{deviceName} 查到平台设备 → 若来源为分享码先调 GET /isShareDevice → 本接口绑定。
查找设备(按设备名)
| 方法 | 接口地址 |
|---|---|
| GET | /app-api/iot/app-user-device/find/{deviceName} |
响应参数:
data为平台设备信息(id/productKey/deviceName/deviceState/deviceSoftVersion/rssi/productName/productImg 等),id用于后续绑定。
查询是否为分享设备
| 方法 | 接口地址 |
|---|---|
| GET | /app-api/iot/app-user-device/isShareDevice?deviceName=&uuid= |
响应参数:
data为 boolean。
用户设备分页 / 列表
| 方法 | 接口地址 |
|---|---|
| GET | /app-api/iot/app-user-device/page(分页,支持 groupId 分组过滤) |
| GET | /app-api/iot/app-user-device/list(全量列表) |
请求参数(query,均可选)
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| pageNo / pageSize | 分页参数(page 接口) | int |
| name | 设备名模糊查询 | string |
| groupId | 分组id(page 接口过滤) | long |
响应参数(data.list 每项)
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| id | 用户设备id(绑定记录id) | long |
| deviceId / deviceName | 平台设备id / 设备名 | long / string |
| name | 用户自定义设备名 | string |
| userRemark | 用户备注 | string |
| productId / productKey / productName / productImg / productDesc | 产品信息 | - |
| deviceState | 设备状态;-1:未激活;0:离线;1:在线 | int |
| nodeType / networkType / rssi | 节点类型 / 联网类型 / 信号强度 | int |
| lastTimeOnline | 上次上线时间 | string |
| deviceSoftVersion | 固件版本 | string |
| deviceLongitude / deviceLatitude | 经纬度 | string |
| subDeviceCount | 子设备数量 | long |
| controlPanelList | 该设备的控制面板配置列表 | array |
用户设备详情
| 方法 | 接口地址 |
|---|---|
| GET | /app-api/iot/app-user-device/get?id= |
响应字段同上(单对象)。按产品+设备名查询可用 GET /pd?productKey=&deviceName=。
修改设备名 / 备注
| 方法 | 接口地址 |
|---|---|
| PUT | /app-api/iot/app-user-device/modifyUserDeviceName(name:3–20 字符,必填) |
| PUT | /app-api/iot/app-user-device/modifyUserDeviceRemark(userRemark:1–500 字符,必填) |
请求参数:
id(用户设备id,必填)+ 对应字段。响应data为 boolean。
解绑设备
| 方法 | 接口地址 |
|---|---|
| DELETE | /app-api/iot/app-user-device/delete?id= |
响应参数:
data为 boolean。
设备分享
| 接口 | 方法与URL | 说明 |
|---|---|---|
| 生成分享码 | GET /share?id= | data 返回分享二维码内容(含 uuid),他人扫码可绑定 |
| 我分享的设备 | GET /shareDevice | 返回列表额外含被分享人 userNickname / userAvatar |
| 分享给我的设备 | GET /otherShareDevice | 返回列表额外含分享人 shareByUserNickname / shareByUserAvatar |
| 取消分享 | DELETE /cancelShareUserDevice?id= | data 为 boolean |