Get the information about multiple devices

Last Updated on : 2023-06-20 14:18:04download

Get detailed information about multiple devices by the device IDs.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
device_idsStringquerytrueThe device IDs. Multiple IDs are separated by a comma (,). Limit up to 20.

Return parameter

Parameter nameTypeDescription
resultBasePageRes

Description of result

Parameter nameTypeDescription
has_moreBooleanSpecify whether there is another page.
totalLongTotal entries of data that meets the conditions
listListData list

Description of list

Parameter nameTypeDescription
idStringDevice ID
uuidStringDevice UUID
categoryStringProduct category
nameStringDevice name
product_idStringProduct ID
product_nameStringProduct name
local_keyStringSecret key
subBooleanCheck whether it is a sub-device
asset_idStringAsset ID
ipStringThe IP address of the device
lonStringLongitude
latStringLatitude
modelStringProduct model
time_zoneStringThe time zone where the device is located
active_timeLongThe time when the device is activated
update_timeLongThe time when the device is updated
create_timeLongThe time when the device is paired for the first time
onlineBooleanOnline 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.