获取用户的设备列表

更新时间:2023-12-07 03:33:55下载pdf

本文介绍获取用户的设备列表的 API。

接口描述

查询用户可操作的设备列表和各设备的信息,包括设备属性和设备状态等。

接口地址

GET: /v1.0/users/{uid}/devices

请求参数

参数名类型参数位置是否必填说明
uidStringuritrue用户 UID
fromStringqueryfalse来源。
  • home:查询当前用户房屋下的设备
  • share:查询当前用户接收到的分享设备
page_noIntegerqueryfalse当前页,0 为第一页
page_sizeIntegerqueryfalse分页大小

返回参数

参数名类型说明
resultList返回结果

result 说明

参数名类型说明
idString设备 ID
uuidString设备唯一标识
uidString用户 ID
biz_typeInteger应用业务类型标识
nameString设备名称
time_zoneString时区
ipString设备 IP
local_keyString密钥
subBoolean是否为子设备:
  • true:是
  • false:不是
create_timeLong设备初次配网时间
update_timeLong设备状态更新时间
active_timeLong设备上次配网时间
statusList设备功能状态
owner_idString设备拥有者 ID
product_idString产品 ID
product_nameString产品名
categoryString产品类别
iconString设备图标
onlineBoolean是否在线:
  • true:在线
  • false:不在线

status 说明

参数名类型说明
codeString功能 code
valueObject功能值

请求示例

GET: /v1.0/users/ay15***********/devices
GET /v1.0/users/ay15ay15***********/devices?page_no=0&page_size=50

返回示例

{
    "result": [
        {
            "sub": false,
            "create_time": 1540691155,
            "local_key": "11a53bdd67e4****",
            "owner_id": "357****",
            "ip": "**.62.43.**",
            "biz_type": 293964,
            "icon": "smart/product_icon/cz.png",
            "time_zone": "+08:00",
            "uuid": "27511006b4e62d4b****",
            "product_name": "Wi-Fi智能计量插座",
            "active_time": 1548584422,
            "uid": "ay1548569152777Q****",
            "update_time": 1548584559,
            "product_id": "EvolhYPyZNWYP***",
            "name": "xxx测试",
            "online": true,
            "id": "27511006b4e62d4b****",
            "category": "cz",
            "status": [
                {
                    "code": "cur_power",
                    "value": 0
                },
                {
                    "code": "cur_voltage",
                    "value": 2196
                },
                {
                    "code": "switch",
                    "value": false
                },
                {
                    "code": "countdown_1",
                    "value": 0
                },
                {
                    "code": "cur_current",
                    "value": 0
                }
            ]
        }
    ],
    "t": 1564996327422,
    "success": true
}

错误码

参考 错误码