查询家庭下场景列表

更新时间:2024-03-06 09:29:09下载pdf

本文介绍查询家庭下场景列表的 API。

接口描述

查询指定家庭下的场景列表。

接口地址

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

请求参数

参数名类型参数位置是否必填说明
home_idStringurifalse家庭 ID

返回参数

参数名类型说明
resultList返回结果

result 说明

参数名类型说明
scene_idString场景 ID
nameString场景名称
backgroundString背景图片
actionsList动作列表
enabledBoolean是否启用指定的场景

actions 说明

参数名类型说明
entity_idString设备 ID
executor_propertyJSONObject执行动作参数
action_executorString执⾏动作类别,当前仅支持 dpIssue
extra_propertyString执行动作额外信息
action_strategyString执行动作策略

请求示例

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

返回示例

{
    "result": [
        {
            "scene_id": "53IYSXI3gEn2w***",
            "enabled": true,
            "background": "https://images.tuyacn.com/smart/rule/cover/starry.png",
            "name": "开启球泡灯",
            "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": "早上",
            "actions": [
                {
                    "entity_id": "012000715ccf7f4f****",
                    "executor_property": {
                        "switch_led": true
                    },
                    "action_executor": "dpIssue"
                }
            ]
        }
    ],
    "t": 1541071460239,
    "success": true
}

错误码

参考 错误码