场景管理接口

创建场景

  • 接口intent：config.scene.create
  • 接口描述：本接口用于创建场景，可自定义设置场景中需要执行的动作（Actions），当人为触发该场景时，按顺序执行设定的动作。通过“query.ifttt.action”接口查询动作参数说明后，再通过本接口创建场景。
  • 请求参数
名称 类型 是否必须 描述
name String 是 场景名称
positionId String 否 位置 id，为空取默认位置
action Array(Object) 是 场景内容，详见action说明

action说明

名称 类型 是否必须 描述
subjectId String 是 对象ID
actionDefinitionId String 是 action定义id
params Array(Object) 是 参数，详见params说明
delayTime String 否 延时时间，0-59秒；0-59分
delayTimeUnit String 否 延时单位，1-秒；2-分钟

params说明

名称 类型 描述
paramId string 参数id
value String 值
paramType String 参数类型
paramUnit String 单位
  • 请求示例
{
    "intent": "config.scene.create",
    "data": {
        "name": "123",
        "positionId": "real1.768799734012641280",
        "action": [
            {
                "subjectId": "virtual2.11774113824794",
                "actionDefinitionId": "AD.lumi.gateway.set_corridor_light_argb",
                "params": [
                    {
                        "paramType": "0",
                        "paramUnit": "local",
                        "paramId": "PD.lightARGB",
                        "value": "553516541"
                    }
                ]
            }
        ]
    }
}
  • 返回参数
名称 类型 描述
sceneId String 场景ID
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": {
        "sceneId": "AL.836646140352004096"
    }
}

更新场景

  • 接口intent：config.scene.update
  • 接口描述：本接口用于修改场景的参数配置和名称。
  • 请求参数
名称 类型 是否必须 描述
sceneId String 是 场景id
name String 是 场景名称
positionId String 否 位置 id，为空取默认位置
action Array(Object) 是 场景内容，详见action说明

action说明

名称 类型 是否必须 描述
subjectId String 是 对象ID
actionDefinitionId String 是 action定义id
params Array(Object) 是 参数，详见params说明

params说明

名称 类型 描述
paramId string 参数id
value String 值
paramType String 参数类型
paramUnit String 单位
  • 请求示例
{
    "intent": "config.scene.update",
    "data": {
        "sceneId": "AL.836646140352004096",
        "name": "123456",
        "positionId": "real1.768799734012641280",
        "action": [
            {
                "subjectId": "virtual2.11774113824794",
                "actionDefinitionId": "AD.lumi.gateway.open_corridor_light"
            }
        ]
    }
}
  • 返回参数：无
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": ""
}

删除场景

  • 接口intent：config.scene.delete
  • 接口描述：本接口用于删除场景。
  • 请求参数
名称 类型 是否必须 描述
sceneId String 是 场景ID
  • 请求示例
{
    "intent": "config.scene.delete",
    "data": {
        "sceneId": "AL.836646140352004096"
    }
}
  • 返回参数：无
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": ""
}

执行场景

  • 接口intent：config.scene.run
  • 接口描述：本接口用于执行场景。
  • 请求参数
名称 类型 是否必须 描述
sceneId String 是 场景ID
  • 请求参数
{
    "intent": "config.scene.run",
    "data": {
        "sceneId": "AL.829804945617997824"
    }
}
  • 返回参数：无
  • 返回示例
{
    "code": 0,
    "requestId": null,
    "message": null,
    "msgDetails": null,
    "result": ""
}

查询场景详情

  • 接口intent：query.scene.detail
  • 接口描述：本接口用于查询场景的各动作配置详情。
  • 请求参数
名称 类型 是否必须 描述
sceneId String 是 场景id，格式为AL.xxxxx
  • 请求示例
{
    "intent": "query.scene.detail",
    "data": {
        "sceneId": "AL.836639966905348096"
    }
}
  • 返回参数
名称 类型 描述
sceneId String 场景ID
name String 场景名称
localizd int 0:云端 1:本地 3：云端化中 4：本地化中
action Array(Object) 内容，详见action说明

action说明

名称 类型 描述
subjectId String 对象ID
model String 对象类型
actionName String 动作名称
actionDefinitionId String 动作id
params Array(Object) 参数，详见params说明
delayTimeUnit String 延时单位，1-秒；2-分钟
delayTime String 延时时间

params说明

名称 类型 描述
paramId string 参数id
value String 值
paramType String 参数类型
paramUnit String 单位
  • 返回实例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": {
        "localize": 0,
        "sceneId": "AL.836639966905348096",
        "name": "scene",
        "action": [
            {
                "delayTimeUnit": "1",
                "actionDefinitionId": "AD.lumi.gateway.set_corridor_light_argb",
                "model": "lumi.gateway.acn01",
                "delayTime": "0",
                "params": [
                    {
                        "paramType": "0",
                        "paramUnit": "local",
                        "paramId": "PD.lightARGB",
                        "value": "553516541"
                    }
                ],
                "subjectId": "virtual2.13107395143333",
                "actionName": "Turn on the Night Light to the assigned state"
            }
        ]
    }
}

通过对象id查询场景

  • 接口intent：query.scene.listBySubjectId
  • 接口描述：本接口可根据对象ID查询与其相关联的场景列表。
  • 请求参数
名称 类型 是否必须 描述
subjectId String 是 对象id
  • 请求示例
{
    "intent": "query.scene.listBySubjectId",
    "data": {
        "subjectId": "virtual2.11774113824794"
    }
}
  • 返回参数
名称 类型 描述
sceneId string 场景ID
name String 场景名称
model String 设备类型
localizd int 0:云端 1:本地 3：云端化中 4：本地化中
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": [
        {
            "localize": 0,
            "sceneId": "AL.826490847172780032",
            "name": "2",
            "model": "app.scene.v1"
        },
        {
            "localize": 0,
            "sceneId": "AL.831620188783841280",
            "name": "hah",
            "model": "app.scene.v1"
        },
        {
            "localize": 0,
            "sceneId": "AL.832619606283436032",
            "name": "123456",
            "model": "app.scene.v1"
        }
    ]
}

通过位置分页查询场景

  • 接口intent：query.scene.listByPositionId
  • 接口描述：本接口用于查询指定位置下的场景列表。
  • 请求参数
名称 类型 是否必须 描述
positionId String 否 位置ID
pageNum Int 否 页码，默认值1
pageSize Int 否 每页item个数，默认值50
  • 请求示例
{
    "intent": "query.scene.listByPositionId",
    "data": {
        "positionId": "real1.768799734012641280",
        "pageNum": 1,
        "pageSize": 5
    }
}
  • 返回参数
名称 类型 描述
data Array(Object) 场景信息
totalCount int 查询场景数量

data说明：

名称 类型 描述
sceneId string 场景ID
name String 场景名称
model String 设备类型
localizd int 0:云端 1:本地 3：云端化中 4：本地化中
  • 返回示例
{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": {
        "data": [
            {
                "localizd": 0,
                "sceneId": "AL.832619749883822080",
                "name": "123456",
                "model": "app.scene.v1"
            },
            {
                "localizd": 0,
                "sceneId": "AL.832619744657719296",
                "name": "123456",
                "model": "app.scene.v1"
            },
            {
                "localizd": 0,
                "sceneId": "AL.832619739930738688",
                "name": "123456",
                "model": "app.scene.v1"
            },
            {
                "localizd": 0,
                "sceneId": "AL.832619643063287808",
                "name": "123456",
                "model": "app.scene.v1"
            },
            {
                "localizd": 0,
                "sceneId": "AL.832619606283436032",
                "name": "123456",
                "model": "app.scene.v1"
            }
        ],
        "totalCount": 7
    }
}
Copyright © 2023 深圳绿米联创科技有限公司 all right reserved，powered by Gitbook文档修改时间： 2024-09-27 21:51:47

results matching ""

    No results matching ""