Query Scenes in Home

Last Updated on : 2024-01-11 05:57:47download

Based on the home ID, query a list of scenes in the specified home.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
home_idStringuritrueThe home ID.

Return parameter

Parameter nameTypeDescription
resultListThe returned result.

Description of result

Parameter nameTypeDescription
scene_idStringThe scene ID.
nameStringThe scene name.
backgroundStringThe background image.
actionsListThe list of actions.
enabledBooleanSpecifies whether to enable the specified scene.

Description of actions

Parameter nameTypeDescription
entity_idStringThe device ID.
executor_propertyJSONObjectThe property of the executed actions.
action_executorStringThe type of action. Valid value: dpIssue.

Request example

GET: /v1.0/homes/5270711/scenes

Return example

    "tid": "78d991fb7d3b11eeaf40161d72836dc2",
    "result": [
            "scene_id": "qY6dCk****I5Yzz",
            "enabled": true,
            "background": "",
            "name": "Switch On",
            "actions": [
                    "entity_id": "vdevo168****4179625",
                    "executor_property": {
                        "switch_1": true
                    "action_executor": "dpIssue"
    "t": 1699340488009,
    "success": true

Error code

For more information, see error code.