Get the information about multiple devices

Last Updated on : 2023-06-20 15:18:22download

Get detailed information about multiple devices by the device IDs.

API address

GET: /v1.0/iot-03/devices

Request parameter

Parameter name	Type	IN	Required	Description
device_ids	String	query	true	The device IDs. Multiple IDs are separated by a comma (,). Limit up to 20.

Return parameter

Parameter name	Type	Description
result	BasePageRes

Description of result

Parameter name	Type	Description
has_more	Boolean	Specify whether there is another page.
total	Long	Total entries of data that meets the conditions
list	List	Data list

Description of list

Parameter name	Type	Description
id	String	Device ID
uuid	String	Device UUID
category	String	Product category
name	String	Device name
product_id	String	Product ID
product_name	String	Product name
local_key	String	Secret key
sub	Boolean	Check whether it is a sub-device
asset_id	String	Asset ID
ip	String	The IP address of the device
lon	String	Longitude
lat	String	Latitude
model	String	Product model
time_zone	String	The time zone where the device is located
active_time	Long	The time when the device is activated
update_time	Long	The time when the device is updated
create_time	Long	The time when the device is paired for the first time
online	Boolean	Online status

Request example

GET: /v1.0/iot-03/devices?device_ids=xxxxxx1,xxxxxx2

Return example

{
    "result": {
        "list": [
            {
                "sub": false,
                "create_time": 1575017570,
                "local_key": "11d7f7286caa****",
                "ip": "58.251.**.****",
                "asset_id": "1160****",
                "time_zone": "+08:00",
                "product_name": "Wi-Fi smart speaker SS190",
                "uuid": "12****",
                "active_time": 1584063323,
                "uid": "ay156531946658X****",
                "update_time": 1584939489,
                "product_id": "i9vkzktd",
                "name": "Wi-Fi smart speaker SS190",
                "online": false,
                "model": "SS190",
                "id": "747b2165d9449964****",
                "category": "znyxss"
            }
        ],
        "total": 1,
        "has_more": false
    },
    "t": 1591872112140,
    "success": true
}

Error code

For more information, see error code.