Cloud Services API ReferenceSmart HomeSmart Home Basic Service

Smart Home Basic Service

Last Updated on : 2024-04-02 08:55:25download

Provides Tuya smart home basic abilities

Home Management

API Name	URL
Add Home	POST:/v1.0/home/create-home
Query Home	GET:/v1.0/homes/{home_id}
Modify Home	PUT:/v1.0/homes/{home_id}
Delete Family	DELETE:/v1.0/homes/{home_id}
Query Devices in Home	GET:/v1.0/homes/{home_id}/devices
Query Home Members	GET:/v1.0/homes/{home_id}/members
Add Home Member	POST:/v1.0/homes/{home_id}/members
Modify family member information	PUT:/v1.0/homes/{home_id}/members/{uid}
Delete Home Member	DELETE:/v1.0/homes/{home_id}/members/{uid}
Add Room	POST:/v1.0/homes/{home_id}/room
Query Room List	GET:/v1.0/homes/{home_id}/rooms
Delete Room	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}
Modify the room name	PUT:/v1.0/homes/{home_id}/rooms/{room_id}
Query family room equipment	GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Query Home List	GET:/v1.0/users/{uid}/homes
Add a device in the room	POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Modify Room Devices	PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Delete Devices from Room	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Get Device List	GET:/v1.0/devices

Smart Home User Management

API Name	URL
Sync User Account	POST:/v1.0/apps/{schema}/user
Get User Information	GET:/v1.0/users/{uid}/infos
Get User List	GET:/v2.0/apps/{schema}/users
Undelete	POST:/v1.0/users/{uid}/actions/cancel-delete
Pre-delete the user account	POST:/v1.0/users/{uid}/actions/pre-delete
Get User's Device List	GET:/v1.0/users/{uid}/devices

Smart Home Application Management

API Name	URL
Get App Details	GET:/v1.0/apps/{schema}
Get App Information	GET:/v1.1/apps/{schema}

Smart Home Network Management

API Name	URL
Get a list of sub-devices	GET:/v1.0/devices/{deviceId}/list-sub
Allow sub-devices to access the network	PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery
Get the list of network equipment	GET:/v1.0/device/paring/tokens/{token}

Smart Home Device Management

API Name	URL
Query Zigbee devices under the gateway	GET:/v1.0/devices/{deviceId}/sub-devices
Query Factory Information in Bulk	GET:/v1.0/devices/factory-infos
Modify device name	PUT:/v1.0/devices/{device_id}
Query device log	GET:/v1.0/devices/{device_id}/logs
Restore device factory settings	PUT:/v1.0/devices/{device_id}/reset-factory
Get Device Details	GET:/v1.0/devices/{deviceId}
Delete Device	DELETE:/v1.0/devices/{deviceId}
Get Device Status	GET:/v1.0/devices/{deviceId}/status
Get Device List v2	GET:/v2.0/devices
Batch query for the list of associated App user dimension devices	GET:/v1.0/iot-01/associated-users/devices
Delete User	DELETE:/v1.0/devices/{device_id}/users/{user_id}
Modify Device Members	PUT:/v1.0/devices/{device_id}/users/{user_id}
Query Device Members	GET:/v1.0/devices/{device_id}/users/{user_id}
Add Device Member	POST:/v1.0/devices/{device_id}/user
Query Member List by Device ID	GET:/v1.0/devices/{device_id}/users

Smart Home Device Control

API Name	URL
Modify function point name	PUT:/v1.0/devices/{device_id}/functions/{function_code}
Control Device	POST:/v1.0/devices/{deviceId}/commands
Get Instruction Set Supported by Device	GET:/v1.0/devices/{deviceId}/functions
Get Device Specification Attribute	GET:/v1.0/devices/{deviceId}/specifications
Get the instructions set by category	GET:/v1.0/functions/{category}
Get Instruction Sets in Bulk	GET:/v1.0/devices/functions
Get Device Specification Attribute	GET:/v1.1/devices/{device_id}/specifications

Prev DocSmart Home

Next DocHome Management