Query Devices in Home

Last Updated on : 2024-09-10 01:49:20

Based on the home ID, query a list of devices in the specified home.

API address

GET: /v1.0/homes/{home_id}/devices

Request parameter

Parameter name	Type	IN	Required	Description
home_id	Long	uri	true	The home ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
id	String	The device ID.
uuid	String	The universally unique identifier (UUID) of the specified device.
uid	String	The user ID.
biz_type	Integer	The application `bizType`.
name	String	The device name.
time_zone	String	The time zone.
ip	String	The IP address of the specified device.
local_key	String	The secret key.
sub	Boolean	Indicates whether it is a sub-device. Valid values: `true`: yes. `false`: no.
model	String	The product model.
create_time	Long	The time when the device was first paired.
update_time	Long	The time when the device status was last updated.
active_time	Long	The time when the device was last paired.
status	List	The status of the specified device data point.
owner_id	String	The ID of the device owner.
product_id	String	The product ID.
product_name	String	The product name.
category	String	The product category.
icon	String	The URL of the device icon.
online	Boolean	Indicates whether the device is online. Valid values: `true`: The device is online. `false`: The device is offline.
node_id	String	The node ID. When `sub` is `true`, this field applies to a sub-device.
lat	String	The latitude.

Description of status

Parameter name	Type	Description
code	String	The code of the specified data point.
value	Object	The value of the specified data point.

Request example

GET: /v1.0/homes/3196002/devices

Return example

{
    "tid": "cbe7c5807d3811eeaf40161d72836dc2",
    "result": [
        {
            "sub": false,
            "create_time": 1669898482,
            "local_key": "47b69****04f952",
            "owner_id": "16968315",
            "biz_type": 0,
            "ip": "",
            "icon": "smart/icon/ay1550298204274iXb1I/ce28b24ac1bf8f9b1beba4fadc37e***.png",
            "lon": "120.2961",
            "time_zone": "+08:00",
            "product_name": "Fingerbot Plus",
            "uuid": "tuyaa****f514d253",
            "active_time": 1669898482,
            "uid": "ay15913****50677KZlj2",
            "update_time": 1699339271,
            "product_id": "yii****7zh",
            "name": "Fingerbot Plus",
            "online": true,
            "model": "ADFB0301",
            "id": "6cf0ca9****ab76bfjntj",
            "category": "szjqr",
            "lat": "30.3663",
            "status": [
                {
                    "code": "switch",
                    "value": true
                },
                {
                    "code": "mode",
                    "value": "click"
                },
                {
                    "code": "arm_down_percent",
                    "value": 96
                }
            ]
        },
        {
            "sub": false,
            "create_time": 1669898437,
            "local_key": "bf69a****7e54779",
            "owner_id": "16****315",
            "biz_type": 0,
            "ip": "220.191.122.216",
            "icon": "smart/icon/ay1562803410690AUgvL/165491159782534db9***.png",
            "lon": "120.2655",
            "time_zone": "+08:00",
            "product_name": "Bluetooth Mesh Gateway",
            "uuid": "133530a****4bfc92fc",
            "active_time": 1669898437,
            "uid": "ay1591****0677KZlj2",
            "update_time": 1699061536,
            "product_id": "nowfs****fqwzudwr",
            "name": "Bluetooth Mesh Gateway",
            "online": true,
            "model": "JMWBG1",
            "id": "6c9f204****8cff47egj6w",
            "category": "wg2",
            "lat": "30.2210",
            "status": [
            ]
        }
    ],
    "t": 1699339338983,
    "success": true
}

Error code

For more information, see error code.

Prev DocDelete Family

Next DocQuery Home Members