查询家庭下的场景列表

更新时间:2024-01-11 05:57:11下载pdf

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

接口描述

根据家庭 ID,查询家庭下的场景列表。

接口地址

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

请求参数

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

返回参数

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

result 说明

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

actions 说明

参数名类型说明
entity_idString设备 ID
executor_propertyJSONObject执行动作参数
action_executorString执⾏动作类别,当前仅支持 dpIssue

请求示例

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

返回示例

{
    "tid": "78d991fb7d3b11eeaf40161d72836dc2",
    "result": [
        {
            "scene_id": "qY6dCk****I5Yzz",
            "enabled": true,
            "background": "",
            "name": "快速打开开关",
            "actions": [
                {
                    "entity_id": "vdevo168****4179625",
                    "executor_property": {
                        "switch_1": true
                    },
                    "action_executor": "dpIssue"
                }
            ]
        }
    ],
    "t": 1699340488009,
    "success": true
}

错误码

参考 错误码