Query Device Details in Bulk

Last Updated on : 2024-06-29 01:28:38download

This page contains content

API address Request parameter Return parameter Request example Return example Error code Limits on API Request Frequency

Based on a list of device IDs, query the details of multiple devices in bulk.

API address

GET: /v2.0/cloud/thing/batch

Request parameter

Parameter name	Type	IN	Required	Description
device_ids	String	query	true	The list of up to 20 device IDs, separated by commas.

Return parameter

Parameter name	Type	Description
result	List	The list of returned data.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
id	String	The device ID.
active_time	Long	The time when the specified device is activated, which is accurate to seconds.
category	String	The product category of the specified device.
create_time	Long	The time when the specified device is first paired, which is accurate to seconds.
update_time	Long	The time when the specified device is updated, which is accurate to seconds.
custom_name	String	The custom name of the specified device.
icon	String	The icon of the specified device.
ip	String	The IP address of the specified device.
is_online	Boolean	Indicates whether the specified device is online.
lat	String	The latitude of the specified device.
local_key	String	The unique encrypted key of the specified device over LAN.
lon	String	The longitude of the specified device.
name	String	The name of the specified device.
product_id	String	The product ID of the specified device.
product_name	String	The product name of the specified device.
sub	Boolean	Indicates whether the specified device is a sub-device.
time_zone	String	The time zone in which the specified device is located.
uuid	String	The universally unique identifier (UUID) of the specified device.

Request example

GET: /v2.0/cloud/thing/batch?device_ids=vdevo165942257398***

Return example

{
    "tid": "a8bcb54fb8e411eda71e169efc83a172",
    "result": [
        {
            "sub": false,
            "create_time": 1659422574,
            "local_key": "06f4adf1e5fc4***",
            "ip": "124.90.34.***",
            "icon": "smart/icon/baydffaa6539efg/a6cdd065abcde3bfb689152eda***.png",
            "lon": "20.0641",
            "time_zone": "+8.0",
            "product_name": "Robot Vacuum A001",
            "uuid": "vdevo165abcd98***",
            "active_time": 1659422574,
            "update_time": 1659422574,
            "custom_name": "Robot Vacuum in Living Room",
            "product_id": "h9soglkuugftb***",
            "name": "Robot Vacuum-vdevo",
            "id": "vdevo165abcd98***",
            "is_online": true,
            "category": "cz",
            "lat": "50.3029"
        }
    ],
    "t": 1677752774750,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocGet Update Progress

Next DocDelete Device

This page contains content

API address Request parameter Return parameter Request example Return example Error code Limits on API Request Frequency