API List

Last Updated on : 2023-12-07 03:33:44download

This topic describes the APIs of synchronizing users, getting the user list, and getting user information.

Authorization management

APIs used for verifying authorization and acquiring token for Tuya cloud.

API	Description
Get Token	For cloud-cloud docking scenarios, developers can apply for cloud API authorization from the platform, using a simple mode to implicitly obtain tokens.
Refresh Token	Each OAuth token is valid for two hours. After expiration, you need to use refresh_token to replace the previous token.

APIs used for acquiring the users information.

API	Description
Get user information	You can get the detailed information of a single user through this API.
Get user list	Used to obtain user data associated with the IoT platform. The privacy fields in the data will be desensitized. The maximum time interval for obtaining data is 30 days.

APIs used for device basic information setting.

API	Description
Query Zigbee devices under the gateway	You can get the list of Zigbee devices under the gateway through this API.
Batch query equipment factory information	You can query the factory information of devices in batches through this API.
Get device list	Support to obtain device list and corresponding device status information through application, product or device ID dimension.
Modify device name	You can modify the name of the device through this API.
Query device log	Query device operation history records based on conditions.
Restore device factory settings	You can restore the factory settings of the device through this API.
Get device details	You can query the detailed information of the device through this API, including device attributes and the latest status of the device.
Remove device	You can remove the specified device through this API.
Get the user’s device list	You can use this API to query the user-operable device list and the information of each device, including device attributes and device status.
Get device status	Query the latest status of the device based on the device ID. To query the firmware to be upgraded, please call the [Get device upgrade information] interface.
Get device list v2	Get device list v2

APIs used for network distribution.

API	Description
Get a list of sub-devices	Get the list of Zigbee sub-devices that have been successfully deployed.
Allow sub-devices to access the network	You can allow Zigbee devices to discover the gateway through this API.
Get the list of network equipment	You can get a list of network configuration devices through this API, including devices that have been successfully configured and failed.

APIs used for issuing control instructions.

API	Description
Modify function point name	You can modify the function point name through this API.
Control Device	Issue standard instructions to control equipment
Get the instruction set supported by the device	Query the functions supported by the device, and the obtained instructions can be used to issue control.
Get device specification attributes	Acquire the instruction set and status set supported by the device according to the device ID.
Get the instructions set by category	Query the instruction set by category. This instruction set is the most comprehensive instruction set under the Tuya public version category and can be used as a reference for developers. If you are a platform developer, it is recommended to follow this category for development and docking.

APIs used for OTA upgrade.

API	Description
Firmware Upgrade	Upgrade the device firmware to the latest available version. Before upgrading, you can call the [Get Device Upgrade Information] interface to view the firmware version information to be upgraded.
Update device firmware version	Update device firmware version

APIs used for managing the relationship of family and house.

API	Description
Search Family	Query basic family information based on family ID.
Delete Family	Delete family based on family ID.
Query the list of devices under the family	Query the device list under the family according to the family ID.
Query family member list information	Used to query family member list information.
Modify family member information	Used to set administrator or non-administrative role permissions for family members.
Delete family members	Used to delete specified members of the family.
Add Room	Add a room under the family.
Delete Room	You can delete the specified room in the family through this API.
Modify the room name	Modify the name of a room in the family.
Query family room equipment	Used to query the equipment in the family room.
Query user family list	Query the list of households where the user is located.
Add a device in the room	You can add devices in the specified family room through this API.
Delete the device in the room under the family	Used to delete the equipment in the designated room under the family.

APIs used for scene management

API	Description
Get the linkage conditions supported by the device	Acquire linkage conditions or standard function points for executing actions based on the device ID.
Query devices list of supporting scenarios	Used to query the list of devices that support scenarios in the family.
Delete a single scene under the family	Used to delete a scene under the family.
Trigger to execute the specified scene	Used to trigger the execution of the specified scene.
Query the list of default scene graphs	Used to query the list of default scene graphs.
Enable scene	Used to enable the specified scene.
Deactivate scene	Used to deactivate the specified scene.
Enable Automation	Used to enable designated automation scenarios in the home.
Disable automation	Used to deactivate designated automation scenarios in the home.

APIs used for automatic task

API	Description
Query the list of devices that support automation scenarios	Used to query the list of devices that support automation scenarios.
Query Automation Scene	Used to query a single automation scene in the home.
Modify Automation	Used to modify automation scenarios.
Remove Automation	Used to delete home automation scenarios.
Linkage conditions for obtaining family support	Acquire linkage conditions or standard function points for performing actions based on the family ID.

APIs for regular statistics

API	Description
Data Analysis Public Interface	Data Analysis Public Interface

APIs used for functions of smart lock.

API	Description
Query door opening record	Query door opening record
Get door lock alarm record	Get door lock alarm record
Get the latest remote door opening or alarm cover image	Get the latest remote door opening or alarm cover image
Interface for real-time acquisition of alarm cover image and video address	Interface to get the alarm cover image and video address in real time
Get the latest remote door opening or alarm cover picture	Get the last remote door opening or alarm cover image
Interface for real-time acquisition of alarm cover image and video address	Interface to get the alarm cover image and video address in real time

APIs used for functions of proprietary device user management.

API	Description
Delete User	You can delete the specified user from the user list of the device through this API. After the deletion, the user no longer has operation rights on the device.

APIs used for functions of multiple device.

API	Description
Get multi-channel name	You can get the multi-channel name of the device through this API.