场景管理

API 列表

action	描述
scenes.add	添加场景
scenes.edit	修改场景
scenes.delete	删除场景
scenes.trigger	触发执行某个场景
scenes.infos	查询家庭下的场景列表
scenes.default-pictures	查询默认场景图片列表

添加场景

接口说明

给某个家庭下添加场景。

接口地址

action: scenes.add

params 请求参数

参数名	类型	说明	是否必填
home_id	Long	家庭 ID	是
name	String	场景名称	是
background	String	背景图片	是
actions	List	动作列表	是

actions 说明

参数名	类型	说明	是否必填
entity_id	String	执⾏动作实体，当前⽀持：设备，即设备 ID	是
executor_property	JSON	执⾏动作参数	是
action_executor	String	执⾏动作类别，当前⽀持：dpIssue，即默认为 dpIssue	是

请求示例

{
  "action": "scenes.add",
  "params": {
    "home_id": 2422120,
    "name":"添加场景测试",
    "background":"https://images.tuyacn.com/smart/rule/cover/sport.png",
    "actions":[
        {
            "executor_property":{
                "work_mode":"scene_2"
            },
            "action_executor":"dpIssue",
            "entity_id":"0120090568c63a89cb34"
        }
    ]
  }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	String	场景 ID

响应示例

{
 "success": true,
 "t": 1541072348540,
 "result":"53IYSXI3gEn2w3Oc"
}

修改场景

接口说明

修改某个家庭下的场景。

接口地址

action: scenes.edit

params 请求参数

参数名	类型	说明	是否必填
home_id	Long	家庭 ID	是
scene_id	String	场景 ID	是
name	String	场景名称	是
background	String	背景图片	是
actions	List	动作列表	是

actions 说明

参数名	类型	说明	是否必填
entity_id	String	执⾏动作实体，当前⽀持：设备，即设备 ID	是
executor_property	JSON	执⾏动作参数	是
action_executor	String	执⾏动作类别，当前⽀持：dpIssue，即默认为 dpIssue	是

请求示例

{
  "action": "scenes.edit",
  "params": {
    "home_id": 2422120,
    "scene_id": "53IYSXI3gEn2w3Oc",
    "name":"添加场景测试",
    "background":"https://images.tuyacn.com/smart/rule/cover/sport.png",
    "actions":[
        {
            "executor_property":{
                "work_mode":"scene_2"
            },
            "action_executor":"dpIssue",
            "entity_id":"0120090568c63a89cb34"
        }
    ]
  }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	修改成功返回 true

响应示例

{
 "success": true,
 "t": 1541072348540,
 "result": true
}

删除场景

接口说明

删除家庭下的某个场景。

接口地址

action: scenes.delete

params 请求参数

参数名	类型	说明	是否必填
home_id	Long	家庭 ID	是
scene_id	String	场景 ID	是

请求示例

{
  "action": "scenes.delete",
  "params": {
    "home_id": 2422120,
    "scene_id": "53IYSXI3gEn2w3Oc"
  }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	场景删除成功，返回 true

响应示例

{
 "success": true,
 "t": 1541072348540,
 "result": true
}

触发执行某个场景

接口说明

触发执行某个场景。

接口地址

action: scenes.trigger

params 请求参数

参数名	类型	说明	是否必填
home_id	Long	家庭 ID	是
scene_id	String	场景 ID	是

请求示例

{
  "action": "scenes.trigger",
  "params": {
    "home_id": 2422120,
    "scene_id": "53IYSXI3gEn2w3Oc"
  }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	场景触发成功，返回 true

响应示例

{
 "success": true,
 "t": 1541072348540,
 "result": true
}

查询家庭下的场景列表

接口说明

查询家庭下的场景列表。

接口地址

action: scenes.infos

params 请求参数

参数名	类型	说明	是否必填
home_id	Long	家庭 ID	是

请求示例

{
  "action": "scenes.infos",
  "params": {
    "home_id": 2422120
  }
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
scene_id	String	场景 ID
update_time	String	场景名称
background	String	背景图片
actions	List	动作列表

actions 说明

参数名	类型	说明
entity_id	String	执⾏动作实体，当前⽀持设备，即设备 ID
executor_property	JSON	执行动作参数
action_executor	String	执⾏动作类别，当前⽀持 dpIssue

响应示例

{
    "success":true,
    "t":1541071460239,
    "result":[
        {
            "scene_id":"53IYSXI3gEn2w3Oc",
            "name":"开启球泡灯",
            "background":"https://images.tuyacn.com/smart/rule/cover/starry.png",
            "actions":[
                {
                    "entity_id":"0120090568c63a89cb34",
                    "executor_property":{
                        "work_mode":"scene_2"
                    },
                    "action_executor":"dpIssue"
                }
            ]
        },
        {
            "scene_id":"DKgx28KbdPfzEpvA",
            "name":"早上",
            "background":"https://images.tuyacn.com/smart/rule/cover/sport2.png",
            "actions":[
                {
                    "entity_id":"012000715ccf7f4fb8b5",
                    "executor_property":{
                        "switch_led":true
                    },
                    "action_executor":"dpIssue"
                }
            ]
        }
    ]
}

查询默认场景图⽚列表

接口说明

查询默认场景图⽚列表。

接口地址

action: scenes.default-pictures

params 请求参数

无

params 请求示例

{
  "action": "scenes.default-pictures"
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	List	返回结果(场景图⽚地址列表)

响应示例

{
    "result": [
        "https://images.tuyacn.com/smart/rule/cover/starry.png",
        "https://images.tuyacn.com/smart/rule/cover/air.png",
        "https://images.tuyacn.com/smart/rule/cover/sport.png",
        "https://images.tuyacn.com/smart/rule/cover/bedroom.png",
        "https://images.tuyacn.com/smart/rule/cover/work.png"
    ],
    "success": true,
    "t": 1583847698063
}