Query Scenes in Home

Last Updated on : 2024-03-06 09:29:19download

Query the list of scenes in the specified home.

API address

GET: /v1.1/homes/{home_id}/scenes

Request parameter

Parameter name	Type	IN	Required	Description
home_id	String	uri	false	The home ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
scene_id	String	The scene ID.
name	String	The scene name.
background	String	The background image.
actions	List	The list of actions.
enabled	Boolean	Specifies whether to enable the specified scene.

Description of actions

Parameter name	Type	Description
entity_id	String	The device ID.
executor_property	JSONObject	The property of the specified execution action.
action_executor	String	The type of action. Valid value: `dpIssue`.
extra_property	String	The additional information of the specified action.
action_strategy	String	The strategy of the specified execution action.

Request example

GET: /v1.1/homes/6****/scenes

Return example

{
    "result": [
        {
            "scene_id": "53IYSXI3gEn2w***",
            "enabled": true,
            "background": "https://images.tuyacn.com/smart/rule/cover/starry.png",
            "name": "Turn on light bulb",
            "actions": [
                {
                    "entity_id": "0120090568c63a89****",
                    "executor_property": {
                        "work_mode": "scene_2"
                    },
                    "action_executor": "dpIssue"
                }
            ],
            "status": "1"
        },
        {
            "scene_id": "DKgx28KbdPfz****",
            "background": "https://images.tuyacn.com/smart/rule/cover/****.png",
            "name": "Morning",
            "actions": [
                {
                    "entity_id": "012000715ccf7f4f****",
                    "executor_property": {
                        "switch_led": true
                    },
                    "action_executor": "dpIssue"
                }
            ]
        }
    ],
    "t": 1541071460239,
    "success": true
}

Error code

For more information, see error code.