Query Device Capability Status

Last Updated on : 2022-11-11 03:43:50

Query all capabilities of the specified device. You can also precisely filter the capabilities based on capability_code and channels.

API address

GET: /v1.0/iot-03/devices/{device_id}/capabilities

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
capability_code	String	query	false	The code of a specified capability.
channels	String	query	false	The list of channels, applicable to multi-channel products, such as a power strip.

Return parameter

Parameter name	Type	Description
result	Object	The returned result. The structure is `Map`, the `key` is the capability code, and the value is the status value set of the capabilities. For example: { "switch":[ { "channel":"1", "value":false } ]}

Request example

GET: /v1.0/iot-03/devices/64***dz/capabilities?capability_code=switch

Return example

{
    "result": {
        "countdown": [//Capability code
            {
                "channel": "9",
                "value": 0
            }
        ],
        "relay_status": [//Capability code
            {
                "channel": "38",
                "value": "power_off"
            }
        ],
        "switch": [//Capability code
            {
                "channel": "1",
                "value": false
            }
        ]
    },
    "success": true,
    "t": 1668069255415,
    "tid": "75c83d6b60d211ed8b2566906d2287eb"
}

Error code

For more information, see error code.