Discover Devices

Last Updated on : 2021-07-16 07:39:35download

Query the information about all devices of a specified user.

API address

GET: /v1.0/iot-01/voice/users/{uid}/devices

Request parameter

Parameter name	Type	IN	Required	Description
uid	String	uri	true	The user ID.

Return parameter

Parameter name	Type	Description
result	Object	The returned result.
success	Boolean	Indicates whether the operation is successful. `true`: succeeded. `false`: failed.
t	Long	The returned 13-bit timestamp.
code	Integer	The response code. It is empty on success.
msg	String	The error message that is returned if the request fails. It is empty on success.

Description of result

Parameter name	Type	Description
devices	List	The object collection of multiple devices.
version	String	The version number.
message_id	String	The request identifier.

Description of devices

Parameter name	Type	Description
capabilities	List	The collection of standard capabilities.
category	String	The standard category.
device_id	String	The primary key of a specified device.
device_name	String	The device name.

Description of capabilities

Parameter name	Type	Description
attributes	List	The collection of standard attributes.
commands	List	The collection of standard capabilities.
interface_name	String	The interface type.
support_query	Boolean	Indicates whether the information can be queried.
support_report	Boolean	Indicates whether the information can be reported.

Description of attributes

Parameter name	Type	Description
code	String	The standard attribute.
rang_type	String	The value type.
range_value	Object	The value range.

Request example

GET: /v1.0/iot-01/voice/users/ay1618816013155*****/devices

{}

Return example

{
    "result": {
        "devices": [
            {
                "capabilities": [
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.PowerstateController",
                        "support_query": true,
                        "attributes": [
                            {
                                "code": "powerstate",
                                "rang_type": "onOff"
                            }
                        ],
                        "commands": [
                            "TurnOn",
                            "TurnOff"
                        ]
                    }
                ],
                "device_id": "vdevo16196866******",
                "device_name": "plug",
                "category": "smartplug"
            },
            {
                "capabilities": [
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.BrightnessController",
                        "support_query": true,
                        "attributes": [
                            {
                                "code": "brightness",
                                "rang_type": "percent"
                            }
                        ],
                        "commands": [
                            "SetBrightness",
                            "DecrementBrightness",
                            "IncrementBrightness"
                        ]
                    },
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.PowerstateController",
                        "support_query": true,
                        "attributes": [
                            {
                                "code": "powerstate",
                                "rang_type": "onOff"
                            }
                        ],
                        "commands": [
                            "TurnOn",
                            "TurnOff"
                        ]
                    },
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.ColorTemperatureController",
                        "support_query": false,
                        "attributes": [
                            {
                                "code": "colorTemperature",
                                "rang_type": "percent"
                            }
                        ],
                        "commands": [
                            "SetColorTemperature",
                            "IncrementColorTemperature",
                            "DecrementColorTemperature"
                        ]
                    }
                ],
                "device_id": "vdevo162078*****",
                "device_name": "Rxpower-Wifi-vdevo",
                "category": "light"
            }
        ],
        "message_id": "1dff3264-bb21-4f1c-b32b-d9106082fe23",
        "version": "V1.0"
    },
    "t": 1620981986459,
    "success": true
}

Error code

For more information, see error code.