智慧人居服务

更新时间：2019-04-12 15:26:26

a1. 概览

此文档了提供了智慧人居相关的服务接口
公共字段：以下参数通过登录信息中提取，不需要每次调用的时候传递

2. 设备管理服务

2.1. 常用设备列表

2.1.1. 定义描述

2.1.2. 请求参数

2.1.3. 返回参数

2.1.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "houseId": "houseId1234",
        "pageNo": 1,
        "pageSize": 20
    }
}

• 返回实例

{
    "data": [
        {
            "identityId": "5076al2344c628cf6dabb6137a7c3021cb3f4519", 
            "iotId": "SwLa4NGAoEllg0TGzgAo0010bf1100", 
            "productKey": "a1XHsQqSfck", 
            "deviceName": "SwLa4NGAoEllg0TGzgAo", 
            "productName": "测试", 
            "categoryImage": "http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/daily/image/1524297802609.jpeg", 
            "netType": "NET_WIFI", 
            "thingType": "DEVICE", 
            "status": 0, 
            "nodeType": "DEVICE", 
            "owned": 1, 
            "identityAlias": "我是东芝an001", 
            "gmtCreate": "Jun 7, 2018 3:01:15 PM", 
            "gmtModified": "Jun 7, 2018 3:14:48 PM", 
            "roomInfo": {
                "spaceName": "房间1", 
                "spaceOrder": 0, 
                "houseId": "cFTOoq0qx6OGn9gvNBZV00001c5a10", 
                "spaceId": "9ddb8753c18b40afa285b32e89ac3746"
            }
        }
    ], 
    "pageSize": 30, 
    "pageNo": 1, 
    "total": 1
}

2.2. 更新常用设备列表

2.2.1. 定义描述

2.2.2. 请求参数

2.2.3. 返回参数

2.2.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "houseId": "houseId1234",
        "iotIdList": ["device1","device2"]
    }
}

• 返回实例

{
    "code": 200,
    "message": "success"
}

2.3. 修改设备昵称

2.3.1. 定义描述

2.3.2. 请求参数

2.3.3. 返回参数

2.3.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
      "apiVer": "1.0.0",
      "iotToken": "token"
    },
    "params": {
      "iotId": "iotId1234",
      "deviceNickname": "nickname"
    }
}

• 返回实例

{
    "code": 200,
    "message": "success"
}

2.5. 解绑设备

2.5.1. 定义描述

2.5.2. 请求参数

2.5.3. 返回参数

2.5.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "iotId1234"
    }
}

• 返回实例

{
    "code": 200,
    "message": "success"
}

2.6. 转移设备到房间（在同一个家中)

2.6.1. 定义描述

2.6.2. 请求参数

2.6.3. 返回参数

2.6.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "toRoomId": "roomId1234",
        "iotIdList": ["device1","device2"]
    }
}

• 返回实例

{
    "code": 200,
    "message": "success"
}

2.7. 获取房间下设备列表

2.7.1. 定义描述

2.7.2. 请求参数

2.7.3. 返回参数

2.7.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "roomId": "roomId1234",
        "nodeType": "DEVICE",
        "pageNo": 1,
        "pageSize": 20
    }
}

• 返回实例

{
    "data": [
        {
            "identityId": "5076al2344c628cf6dabb6137a7c3021cb3f4519", 
            "iotId": "SwLa4NGAoEllg0TGzgAo0010bf1100", 
            "productKey": "a1XHsQqSfck", 
            "deviceName": "SwLa4NGAoEllg0TGzgAo", 
            "productName": "测试", 
            "categoryImage": "http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/daily/image/1524297802609.jpeg", 
            "nickName": "device_cc", 
            "netType": "NET_WIFI", 
            "thingType": "DEVICE", 
            "status": 0, 
            "nodeType": "DEVICE", 
            "owned": 1, 
            "identityAlias": "我是东芝an001", 
            "gmtCreate": "Jun 7, 2018 3:00:16 PM", 
            "gmtModified": "Jun 7, 2018 3:13:55 PM"
        }
    ], 
    "pageSize": 20, 
    "pageNo": 1, 
    "total": 1
}

2.8. 管理员查看成员在房间下设备列表

2.8.1. 定义描述

2.8.2. 请求参数

2.8.3. 返回参数

2.8.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "roomId": "roomId1234",
        "memberIdentityId": "identityId1234",
        "nodeType": "DEVICE",
        "pageNo": 1,
        "pageSize": 20
    }
}

• 返回实例

{
    "data": [
        {
            "identityId": "5076al2344c628cf6dabb6137a7c3021cb3f4519", 
            "iotId": "SwLa4NGAoEllg0TGzgAo0010bf1100", 
            "productKey": "a1XHsQqSfck", 
            "deviceName": "SwLa4NGAoEllg0TGzgAo", 
            "productName": "测试", 
            "categoryImage": "http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/daily/image/1524297802609.jpeg", 
            "nickName": "device_cc", 
            "netType": "NET_WIFI", 
            "thingType": "DEVICE", 
            "status": 0, 
            "nodeType": "DEVICE", 
            "owned": 1, 
            "identityAlias": "我是东芝an001", 
            "gmtCreate": "Jun 7, 2018 3:00:16 PM", 
            "gmtModified": "Jun 7, 2018 3:13:55 PM", 
            "roomInfo": {
                "spaceName": "房间1", 
                "spaceOrder": 0, 
                "houseId": "cFTOoq0qx6OGn9gvNBZV00001c5a10", 
                "spaceId": "9ddb8753c18b40afa285b32e89ac3746"
            }
        }
    ], 
    "pageSize": 20, 
    "pageNo": 1, 
    "total": 1
}

2.9. 获取房屋下设备列表

2.9.1. 定义描述

2.9.2. 请求参数

2.9.3. 返回参数

2.9.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "houseId": "houseId1234",
        "nodeType": "DEVICE",
        "pageNo": 1,
        "pageSize": 20
    }
}

• 返回实例

{
    "data": [
        {
            "identityId": "5076al2344c628cf6dabb6137a7c3021cb3f4519", 
            "iotId": "SwLa4NGAoEllg0TGzgAo0010bf1100", 
            "productKey": "a1XHsQqSfck", 
            "deviceName": "SwLa4NGAoEllg0TGzgAo", 
            "productName": "测试", 
            "categoryImage": "http://iotx-paas-admin.oss-cn-shanghai.aliyuncs.com/daily/image/1524297802609.jpeg", 
            "nickName": "device_cc", 
            "netType": "NET_WIFI", 
            "thingType": "DEVICE", 
            "status": 0, 
            "nodeType": "DEVICE", 
            "owned": 1, 
            "identityAlias": "我是东芝an001", 
            "gmtCreate": "Jun 7, 2018 3:00:16 PM", 
            "gmtModified": "Jun 7, 2018 3:13:55 PM", 
            "roomInfo": {
                "spaceName": "房间1", 
                "spaceOrder": 0, 
                "houseId": "cFTOoq0qx6OGn9gvNBZV00001c5a10", 
                "spaceId": "9ddb8753c18b40afa285b32e89ac3746"
            }
        }
    ], 
    "pageSize": 20, 
    "pageNo": 1, 
    "total": 1
}

3. 场景管理服务

3.1. 查询场景列表

3.1.1. 定义描述

3.1.2. 请求参数

3.1.3. 返回参数

3.1.4. 使用说明

3.1.5. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId": "houseId1234",
        "pageSize": 10,
        "pageNo": 1
    }
}

• 返回示例

{
    "code": 200,
    "data": {
        "pageNo": 1,
        "pageSize": 20,
        "scenes": [{
            "description": "电热毯-hy-信噪比--127 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId1",
            "name": "电热毯",
            "status": 2
        }, {
            "description": "light-hy-LightSwitch-1, shuijin-hy-WiFI_SNR--127 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId2",
            "name": "凉宫",
            "status": 1
        }, {
            "description": "fengsan-hy-PowerSwitch-关闭, light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId3",
            "name": "风扇灯0522",
            "status": 1
        }, {
            "description": "light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId4",
            "name": "灯0522",
            "status": 2
        }, {
            "description": "fengsan-hy-PowerSwitch-关闭 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId5",
            "name": "的",
            "status": 1
        }, {
            "description": "light-hy-LightSwitch-1, light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId6",
            "name": "两个灯0522",
            "status": 2
        }, {
            "description": "light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId7",
            "name": "灯",
            "status": 2
        }, {
            "description": "light-hy-LightSwitch-1, light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId8",
            "name": "两个灯",
            "status": 2
        }, {
            "description": "light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId9",
            "name": "灯",
            "status": 2
        }, {
            "description": "light-hy-NightLightSwitch-关闭1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "sceneId10",
            "name": "测",
            "status": 2
        }],
        "total": 33
    },
    "message": "success"
}

3.2. 改变场景列表中表项的排序

3.2.1. 定义描述

3.2.2. 请求参数

3.2.3. 返回参数

3.2.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId": "houseId1234",
        "newOrders": [{
            "fromOrder": 1,
            "sceneId": "sceneId1",
            "toOrder": 2
        }, {
            "fromOrder": 2,
            "sceneId": "sceneId1",
            "toOrder": 1
        }]
    }
}

• 返回实例

{
    "code": 200,
    "message": "success"
}

3.3. 触发场景

3.3.1. 定义描述

3.3.2. 请求参数

3.3.3. 返回参数

3.3.4. 示例

• 请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId": "house1234",
        "sceneId": "sceneId1"
    }
}

• 返回实例

{
    "code": 200,
    "data": "sceneId1",
    "message": "success"
}

3.4. 获取场景日志列表

3.4.1. 定义描述

3.4.2. 请求参数

场景日志查询的方式：

场景日志需要指定一个查询的时间起点，定义为T1，后端会查从T1开始向前追溯15天的日志，即

[T1-15360024, T1] 这个时间段之间的日志

故约定：App端打开日志查询的界面时，记录下页面打开的时间点作为T1，在后续的查询中，一直携带T1作为nowTime。

如果页面要查看T1之后的某个时间点开始的Log，需要重新指定此时的时间点T2，并且把已查询到的结果全部删除掉，令pageNo=1，重新开始查询。

3.4.3. 返回参数

3.4.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "pageNo": 1,
        "pageSize": 10,
        "groupId": "house1234",
        "nowTime": 1527129084824
    }
}

• 返回示例

{
    "code": 200,
    "data": {
        "logs": [{
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000056576d52bf",
            "result": 0,
            "sceneId": "sceneId1",
            "sceneName": "t时间设备",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000056577d52bf",
            "result": 0,
            "sceneId": "sceneId2",
            "sceneName": "t时间",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000036575d52bf",
            "result": 0,
            "sceneId": "sceneId3",
            "sceneName": "测",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000056578d52bf",
            "result": 0,
            "sceneId": "sceneId4",
            "sceneName": "t时间设备",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270549875871014d52bf",
            "result": 1,
            "sceneId": "sceneId5",
            "sceneName": "灯",
            "time": 1527054987000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269604322384548d3112",
            "result": 1,
            "sceneId": "sceneId6",
            "sceneName": "灯0522",
            "time": 1526960432000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550384782579d3112",
            "result": 1,
            "sceneId": "sceneId7",
            "sceneName": "灯",
            "time": 1526955038000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550370082578d3112",
            "result": 1,
            "sceneId": "sceneId8",
            "sceneName": "两个灯0522",
            "time": 1526955037000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550356242576d3112",
            "result": 1,
            "sceneId": "sceneId9",
            "sceneName": "灯",
            "time": 1526955035000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550340772575d3112",
            "result": 1,
            "sceneId": "sceneId10",
            "sceneName": "两个灯0522",
            "time": 1526955034000
        }],
        "pageNo": 1,
        "pageSize": 10,
        "total": 62
    },
    "message": "success"
}

3.5. 获取失败日志详情

3.5.1. 定义描述

3.5.2. 请求参数

3.5.3. 返回参数

3.5.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "pageNo": 1,
        "pageSize": 1000,
        "groupId": "houseId1234",
        "logId": "0bc19f5d15270912000056576d52bf",
        "sceneId": "sceneId1",
        "time": 1527091200000
    }
}

• 应答示例

{
    "code": 200,
    "data": {
        "details": [{
            "detail": "light-hy - NightLightSwitch - 关闭1 设置设备参数",
            "deviceName":"1yhy",
            "failedReason": "device in scene's action is unbind",
            "productKey": "product"
        }],
        "pageNo": 1,
        "pageSize": 1000
    },
    "message": "success"
}

3.6. 获取场景详情

3.6.1. 定义描述

3.6.2. 请求参数

3.6.3. 返回参数

3.6.4. triggers对象的定义

Triggers Item的结构定义

触发器-设备状态

{
    "params": {
        "localizedProductName": "电热毯-hy", // 产品本地描述
        "iotId": "SYxxxxxxxxxxxxxz00103d0c00", // 设备id
        "localizedPropertyName": "信噪比", // 属性本地描述
        "localizedCompareValueName": "开启", // 比较值的本地描述
        "productImage": "http://" // 产品图标
        "deviceNickName": "电热毯", // 设备昵称
        "propertyName": "WiFI_SNR", // 属性名
        "compareType": ">", // 比较类型，支持>, >=, ==,<=,<, !=,in,like等
        "compareValue": 1, // 属性值
        "productKey": "b1xxxxxxUql", // pk
        "deviceName": "hyxxxxx4" // 设备名称
    },
    "uri": "trigger/device/property"
}

触发器-定时器

{
    "params": {
        "cron": "1 1 * * *",
        "cronType": "linux",
        "timezoneID": "Asia/Shanghai" // 时区id，默认为'Asia/Shanghai'
    },
    "uri": "trigger/timer"
}

3.6.5. conditions对象的定义

Conditions Item的结构定义

条件节点-时间区间判断

{
    "uri": "logical/and",
    "items": [{
        "params": {
            "cron": "20-25 11-23 * * 1,2,3,4,5,6,7",
            "cronType": "linux",
            "timezoneID": "Asia/Shanghai"
        },
        "uri": "condition/timeRange"
    }]
}

条件节点-设备属性数据

{
    "params": {
        "localizedProductName": "电热毯-hy", // 产品本地描述
        "localizedPropertyName": "信噪比", // 属性本地描述
        "localizedCompareValueName": "开启", // 比较值的本地描述
        "deviceNickName": "电热毯", // 设备昵称
        "iotId": "SY7a6xxxxxxxxxxxxxxxd0c00", // 设备id
        "productImage": "http://" // 产品图标
        "propertyName": "WiFI_SNR", // 属性名
        "compareType": "==", // 比较类型，支持>, >=, ==,<=,<, !=,in,like等
        "compareValue": 1, // 属性值
        "productKey": "b1xxxxxxql", // pk
        "deviceName": "hyxxxx4" // 设备名称
    },
    "uri": "condition/device/property"
}

3.6.6. actions 对象定义

动作-设置设备状态

{
    "params": {
        "localizedProductName": "电热毯", // 产品本地描述
        "iotId": "SYxxxxxxxxxxxxxxxxxc00", // 设备id
        "propertyName": "WiFI_SNR", // 属性名
        "localizedPropertyName": "信噪比", // 属性本地描述
        "deviceNickName": "电热毯-hy",// 设备昵称
        "productImage": "http://" // 产品图标
        "propertyValue": -127, // 属性值
        "productKey": "b1xxxxxxxxql", // pk
        "deviceName": "hyxxxxx4" // 设备名称
    },
    "uri": "action/device/setProperty",
    "status": 0 //表示设备状态：0:无效，1:有效，用于展示场景的时候对失效设备置灰
}

动作节点-向终端发消息

{
    "uri": "action/mq/send",
    "params": {
        "msgTag": "iot_linkvision_storage_record_start",
        "customData": "hello world"
    }
}

动作节点-开关场景开关 0关1开

{
    "uri": "action/automation/setSwitch",
    "params": {
        "automationRuleId": "scenId",
        "switchStatus": 0
    }
}

3.6.7. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "sceneId": "26xxxxxxxxxxxxxxxxxx [1be22",
        "groupId": "houseId1234"
    }
}

• 返回示例

{
    "code": 200,
    "data": {
        "triggers": {
            "params": {},
            "items": [{
                "params": {
                    "localizedProductName": "智能开关-单键",
                    "localizedPropertyName": "电源开关_1",
                    "deviceNickName": "开关-单键",
                    "iotId": "v9Oxxxxxxxxxxxxxxxxxxx00",
                    "compareValue": 1,
                    "compareType": "==",
                    "propertyName": "PowerSwitch_1",
                    "localizedCompareValueName": "开启",
                    "productImage": "http://ueim_em.tn",
                    "productKey": "a1xxxxxxxx3S",
                    "deviceName": "ZFxxxxxxxx003"
                },
                "uri": "trigger/device/property"
            }],
            "uri": "logical/or"
        },
        "condition": {
            "uri": "logical/and",
            "items": [{
                "params": {
                    "cron": "1-1 10-18 * * 1,2,4,6,7",
                    "cronType": "linux",
                    "timezoneID": "Asia/Shanghai"
                },
                "uri": "condition/timeRange"
            }],
            "actions": [{
                "uri": "action/scene/trigger",
                "params": {
                    "name": "场景",
                    "sceneId": "3cdxxxxxxxxxxxxxxxxxxxxxxxxxx850",
                    "icon": "http://"
                }
            }, {
                "params": {
                    "localizedProductName": "电热毯",
                    "iotId": "SY7xxxxxxxxxxxxxxxxxxxxxx0c00",
                    "propertyName": "WiFI_SNR",
                    "localizedPropertyName": "信噪比",
                    "deviceNickName": "电热毯",
                    "productImage": "http://bourn_ess.tn",
                    "propertyValue": -127,
                    "productKey": "b1xxxxxxql",
                    "deviceName": "hyxxxxx4"
                },
                "uri": "action/device/setProperty",
                "status": 1
            }],
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "name": "电热毯",
            "sceneId": "26xxxxxxxxxxxxxxxxxxbe22",
            "status": 2
        },
        "message": "success"
    }
}

3.7. 创建场景

3.7.1. 定义描述

3.7.2. 请求参数

注：action不能为空，trigger可以空，condition可以空

3.7.3. 返回参数

Triggers对象的定义

触发器-设备状态

{
    "params": {
        "iotId": "SY7xxxxxxxxxxxxxxxxxxxx0c00", // 设备id
        "propertyName": "WiFI_SNR", // 属性名
        "compareType": ">", // 比较条件
        "compareValue": -127, // 属性值
    },
    "uri": "trigger/device/property"
}

触发器-定时器

{
    "params": {
        "cron": "1 1 * * *",
        "cronType": "linux",
        "timezoneID": "Asia/Shanghai"
    },
    "uri": "trigger/timer"
}

conditions对象的定义

条件节点-时间区间判断

{
    "uri": "logical/and",
    "items": [{
        "params": {
            "cron": "20-25 11-23 * * 1,2,3,4,5,6,7",
            "cronType": "linux",
            "timezoneID": "Asia/Shanghai"
        },
        "uri": "condition/timeRange"
    }]
}

条件节点-设备属性数据

{
    "params": {
        "iotId": "SY7xxxxxxxxxxxxxxxxxxxxx00", // 设备id
        "propertyName": "WiFI_SNR", //  属性名
        "compareValue": -127, // 属性值
        "compareType": ">", // 比较条件
    },
    "uri": "condition/device/property"
}

actions 对象定义

动作-设置设备状态

{
    "params": {
        "iotId": "SYxxxxxxxxxxxxxxxxxxxxxxxx00", // 设备id
        "propertyName": "WiFI_SNR", // 属性名
        "propertyValue": -127, // 属性值
    },
    "uri": "action/device/setProperty"
}

动作节点-向终端发消息

{
    "uri": "action/mq/send",
    "params": {
        "msgTag": "iot_linkvision_storage_record_start",
        "customData": "hello world"
    }
}

动作节点-开关场景开关 0关1开

{
    "uri": "action/automation/setSwitch",
    "params": {
        "automationRuleId": "scenId",
        "switchStatus": 0
    }
}

3.7.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId":"houseId123",
        "enable": true,
        "icon": "https://g.aliplus.com/scene_icons/default.png",
        "name": "一样",
        "triggers": {
            "params": {},
            "items": [{
                    "params": {
                        "compareValue": 1,
                        "iotId": "Kpxxxxxxxxxxxxxxxxxxxxx00",
                        "compareType": "==",
                        "propertyName": "ContactState"
                    },
                    "uri": "trigger/device/property" 
                },
                {
                    "params": {
                        "cron": "1 1 * * *",
                        "cronType": "linux",
                        "timezoneID": "Asia/Shanghai"
                    },
                    "uri": "trigger/timer"
                }
            ],
            "uri": "logical/or"
        },
        "conditions": {
            "items": [{
                "params": {
                    "compareValue": 0,
                    "iotId": "gaIxxxxxxxxxxxxxxxxxxxx00",
                    "compareType": "==",
                    "propertyName": "LightSwitch"
                },
                "uri": "condition/device/property",
                "status": 1
            }],
            "uri": "logical/and"
        },
        "actions": [{
            "params": {
                "iotId": "zjxxxxxxxxxxxxxxxxxxxxx00",
                "propertyName": "Qu0wChfloat",
                "propertyValue": 1
            },
            "uri": "action/device/setProperty"
        }]
    }
}

• 返回示例

{
    "code": 200,
    "data": "dexxxxxxxxxxxxxxxxxxxxxc2",
    "message": "success"
}

3.8. 更新场景

3.8.1. 定义描述

3.8.2. 请求参数

3.8.3. 返回参数

*更新场景的tca定义和创建场景的tca定义相同

3.8.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId":"houseId123",
        "enable": true,
        "icon": "https://g.aliplus.com/scene_icons/default.png",
        "name": "",
        "sceneId": "bdc6xxxxxxxxxxxxxxxxxx697",
        "triggers": {
            "params": {},
            "items": [{
                    "params": {
                        "compareValue": 1,
                        "iotId": "Kpxxxxxxxxxxxxxxxxxxxxx00",
                        "compareType": "==",
                        "propertyName": "ContactState"
                    },
                    "uri": "trigger/device/property" 
                },
                {
                    "params": {
                        "cron": "0 0 * * *",
                        "cronType": "linux",
                        "timezoneID": "Asia/Shanghai"
                    },
                    "uri": "trigger/timer"
                }
            ],
            "uri": "logical/or"
        },
        "conditions": {
            "items": [{
                "params": {
                    "compareValue": 0,
                    "iotId": "gaIxxxxxxxxxxxxxxxxxxxx00",
                    "compareType": "==",
                    "propertyName": "LightSwitch"
                },
                "uri": "condition/device/property",
                "status": 1
            }],
            "uri": "logical/and"
        },
        "actions": [{
            "params": {
                "iotId": "gaIxxxxxxxxxxxxxxxxxxxx00",
                "propertyName": "NightLightSwitch",
                "propertyValue": 0
            },
            "uri": "action/device/setProperty",
            "status": 1
        }]
    }
}

• 返回示例

{
    "code": 200,
    "data": "bdc6xxxxxxxxxxxxxxxxxx697",
    "message": "success"
}

3.9. 删除场景

3.9.1. 定义描述

3.9.2. 请求参数

3.9.3. 返回参数

3.9.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "sceneId": "0c9xxxxxxxxxxxxxxxxxxxx657",
        "groupId": "houseId1234"
    }
}

• 返回示例

{
    "code": 200,
    "data": "0c9xxxxxxxxxxxxxxxxxxxx657",
    "message": "success"
}

3.10. 房屋管理员为用户分配场景权限

3.10.1. 定义描述

3.10.2. 请求参数

3.10.3. 返回参数

3.10.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "targetIdentityId": "5029op6f2c030c839xxxxxxb906282", 
        "groupId": "0BH05hTH7j6Kdw4xxxx510", 
        "action": "bind", 
        "sceneIds": [
            "13ae01395f72xxxx3bd5bdc6"
        ]
    }
}

• 返回示例

{
    "code": 200,
    "message": "success"
}

3.11. 房屋管理员查询成员场景权限列表

注：这个列表是房屋下的所有场景列表

3.11.1. 定义描述

3.11.2. 请求参数

3.11.3. 返回参数

3.11.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "targetIdentityId": "5029op6f2c030xxxx11794e662b906282", 
        "pageNo": 1, 
        "groupId": "0BH05hTH7xxxxx000218510", 
        "pageSize": 10
    }
}

• 返回示例

{
    "code": 200, 
    "data": {
        "data": [
            {
                "accessible": false, 
                "description": "灯-虚拟设备-人居接口测试专用-工作模式-柔和", 
                "gmtCreate": 1533125161000, 
                "icon": "https://g.aliplus.com/scene_icons/holiday.png", 
                "name": "小憩", 
                "sceneId": "13ae01395f724xxxx463bd5bdc6"
            }
        ], 
        "pageNo": 1, 
        "pageSize": 10, 
        "total": 5
    }, 
    "message": "success"
}

3.12.1. 定义描述

3.12.2. 请求参数

3.12.3. 返回参数

注：

1. 普通用户拉取其场景列表，使用/scene/list/get

2. 管理员没有取消自己权限的操作，直接调用删除场景，删除后其他成员也看不到该场景

3.12.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId": "0BH05hTH7xxxxZI0000218510", 
        "sceneIds": [
            "13ae01395f724xxxxxbd5bdc6"
        ]
    }
}

• 返回示例

{
    "code": 200,
    "message": "success"
}

3.13 获取支持Trigger/Condition/Action的设备列表

3.13.1 定义描述

3.13.2 请求参数

3.13.3 返回参数

DeviceInfoDTO结构

1.13.4 示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId":"diemxxxxemieniadsemie",
        "flowType": 0,
        "pageNum": 1,
        "pageSize": 20
    }
}

返回示例

{
    "code": 200,
    "data": {
        "pageNo": 1,
        "pageSize": 20,
        "total":1,
        "data": [{
            "iotId": "45dc6fc753d345b69b01d29f6974e5f7",
            "deviceName": "xxxx",
            "productKey": "xxxx",
            "nickName": "测试设备",
            "image": "https://g.aliplus.com/scene_icons/default.png"
        }]
    },
    "message": "success"
}

3.14 获取设备的Trigger/Condition/Action功能列表

3.14.1 定义描述

3.14.2 请求参数

3.14.3 返回参数

3.14.4示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "iotId": "45dc6fc753d345b69b01d29f6974e5f7",
        "flowType": 0
    }
}

返回示例

{
    "code": 200,
    "data": [{
            "name": "开关",
            "identifier": "switch",
            "categoryType": "xxxx",
            "type": 1
    }],
    "message": "success"
}

3.15 获取设备的Trigger/Condition/Action功能列表与TSL定义

3.15.1 定义描述

3.15.2 请求参数

3.15.3 返回参数

SimplifyAbilityDTOs结构

3.15.4 示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "iotId": "45dc6fc753d345b69b01d29f6974e5f7",
        "flowType": 0
    }
}

返回示例

{
    "code": 200,
    "data": {
      "simplifyAbilityDTOs":[{
            "name": "开关",
            "identifier": "switch",
            "categoryType": "xxxx",
            "type": 1
       }],
      "abilityDsl": {}
    },
    "message": "success"
}

3.16. 替换房屋内场景用到的设备

3.16.1 定义描述

3.16.2 请求参数

3.16.3 返回参数

1. 4. 房屋管理服务

提供一组访问、控制房屋/房间相关的服务，客户端应用可以通过该服务实现获取房屋列表、获取房屋下的房间列表、新增房间、获取房间详情、房间排序等功能。

4.1. 获取房屋列表

4.1.1. 定义描述

4.1.2. 请求参数

4.1.3. 返回参数

4.1.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.0"
    },
    "id": 1508212818676,
    "params": {
        "pageNo":1,
        "pageSize":10
    },
    "version": "1.0"
}

• 返回示例

{
  "code": 200,
  "data": {
    "total":100,
    "data":[
        {
         "houseId":"xxxx", 
         "houseName":"201幢201单元201室"，
         "role":1
        }
    ]
  },
  "message":"success"
}

4.2. 获取房屋下房间列表

4.2.1. 定义描述

4.2.2. 请求参数

4.2.3. 返回参数

4.2.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
        "houseId":"xxxx",
        "pageNo":1,
        "pageSize":10
    },
    "version": "1.0"
}

• 返回示例

{
  "code": 200,
  "data": {
    "total":1,
    "data":[
        {
         "roomId":"xxx", 
         "roomName":"201幢201单元201室",
         "roomOrder":1,
         "roomPicture":"http://xxx.com/xx.png",
         "deviceCount":5
        }
    ]
  },
  "message":"success"
}

4.3. 修改房屋下房间的排序

4.3.1. 定义描述

4.3.2. 请求参数

4.3.3. 返回参数

无

4.3.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "houseId":"xxxx",
            "orderList":[{"roomId":"xx", "fromOrder":1, "toOrder":2}]
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "message":"success"
}

4.4. 获取房间详情

4.4.1. 定义描述

4.4.2. 请求参数

4.4.3. 返回参数

4.4.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "roomId":"xxxx"
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "data":{
         "roomId":"xxx", 
         "roomName":"201幢201单元201室",
         "roomOrder":1,
         "roomPicture":"http://xxx.com/xx.png",
         "deviceCount":5
    },
    "message":"success"
}

4.5. 修改房间信息

4.5.1. 定义描述

4.5.2. 请求参数

4.5.3. 返回参数

无

4.5.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "roomId":"xxx", 
            "roomName":"201幢201单元201室",
            "roomPicture":"http://xxx.com/xx.png",
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "message":"success"
}

4.6. 新建房间

4.6.1. 定义描述

4.6.2. 请求参数

4.6.3. 返回参数

4.6.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "houseId":"xxx", 
            "roomName":"201幢201单元201室",
            "roomPicture":"http://xxx.com/xx.png",
            "deviceList":["xxxx","xxxxx"]
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "message":"success",
    "data":"xxxxx"
}

4.7. 删除房间

4.7.1. 定义描述

4.7.2. 请求参数

4.7.3. 返回参数

见返回示例

4.7.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "houseId":"xxx", 
            "roomId":"201幢201单元201室"
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "message":"success"
}

4.8. 获取房间默认壁纸列表

4.8.1. 定义描述

4.8.2. 请求参数

无

4.8.3. 返回参数

4.8.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "houseId":"xxx", 
            "roomId":"201幢201单元201室"
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "data":[
            {"type":"ROOM_DEFAULT_PICTURE","urlList":["https://img.alicdn.com/tfs/TB1FJwJSFXXXXczXXXXXXXXXXXX-750-1334.jpg"]}, 
            {"type":"HOUSE_DEFAULT_PICTURE", "urlList":["https://img.alicdn.com/tfs/TB1FJwJSFXXXXczXXXXXXXXXXXX-750-1334.jpg"]}
           ],
    "message":"success"
}

4.9. 获取房屋详情

4.9.1. 定义描述

4.9.2. 请求参数

4.9.3. 返回参数

4.9.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.4"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
            "houseId":"xxxx"
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "data":{
        "houseId":"xxx",
        "houseName":"xx",
        "address":{
            "country":"", 
            "province":"",
            "city":"",
            "district":"",
            "detail":""},
        "roomCount":2,
        "deviceCount":5,
        "tenantId":"isv_tenant_id",
        "topSpaceId":"top_space_id"
    },
    "message":"success"
}

4.10. 修改房屋详情

4.10.1. 定义描述

4.10.2. 请求参数

4.10.3. 返回参数

无

4.10.4. 示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.0"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
        "houseId":"xxx",
        "houseName":"xxx",
        "address":{
            "province":"山东"
        }
    },
    "version": "1.0"
}

• 返回示例

{
    "code":200,
    "message":"success"
}

4.11.查询用户房屋信息

4.11.1定义描述

4.11.2请求参数

4.11.3返回参数

4.11.4示例

• 请求示例

{
    "request": {
        "iotToken": "xxxx",
        "apiVer": "1.0.4"
    },
    "id": "xxx-xxx-xxx-xxx-xxx",
    "params": {
        "topSpaceId":"xxx",
        "pageNo":1,
        "pageSize":10
    },
    "version": "1.0"
}

• 返回示例

{
  "code": 200,
  "data": {
    "total":100,
    "data":[
        {
         "houseId":"xxxx", 
         "houseName":"201幢201单元201室"，
         "role":1,
         "addressBuilding":"1",
         "addressUnit":"2",
         "addressDoor":"105"
        }
    ]
  },
  "message":"success"
}

5. 用户管理服务

提供一组与用户相关的服务接口，客户端应用通过本组服务接口可以实现家庭成员的管理等。

注意：apiVer使用最新的版本，当前为1.0.0

5.1. 用户拉取家庭成员列表

返回结果里面包含当前管理员，如果分页的时候前端要专门处理下，比如用户拉去10个用户，可能10个里面有一个是自己。

5.1.1. 定义描述

5.1.2. 请求参数

5.1.3. 返回值

MemberBriefDTO

5.1.4. 使用示例

• 请求

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "houseId": "houseId1234",
        "pageNo": 1,
        "pageSize": 20
    }
}

• 返回值

{
      "code": 200,
      "data": {
        "total": 2,
        "data": [
          {
            "role": "MANAGER",
            "identityId": "5076al2344c628cf6dabb6137a7c3021cb3f4519",
            "memberName": "我是东芝an001",
            "class": "com.aliyun.iotx.homecenter.open.service.dto.MemberBriefDTO"
          },
          {
            "role": "MEMBER",
            "identityId": "508eop390ef57502177dbe786726fc19fa206756",
            "memberName": "无名氏",
            "class": "com.aliyun.iotx.homecenter.open.service.dto.MemberBriefDTO"
          }
        ],
        "pageNo": 1,
        "pageSize": 10,
        "class": "com.aliyun.iotx.homecenter.service.common.PageDTO"
      },
      "message": "success",
      "localizedMsg": null,
      "class": "com.aliyun.iotx.common.base.service.IoTxResult"
    }

5.2. 管理员移除指定的家庭成员

5.2.1. 定义描述

5.2.2. 参数

5.2.3. 返回值

5.2.4. 使用示例

• 请求

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "houseId": "houseId1234",
        "identityIdList": ["id1","id2"]
    }
}

• 返回值

{
    "code": 200,
    "data": null,
    "message": "success",
    "localizedMsg": null,
  }

5.3. 转让管理员

5.3.1. 定义描述

5.3.2. 参数

5.3.3. 返回值

5.3.4. 使用示例

• 请求

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "houseId": "houseId1234",
        "newIdentityId": "newid"
    }
}

• 返回值

{
    "code": 200,
    "data": null,
    "message": "success",
    "localizedMsg": null,
  }

5.4. 管理员更新家庭成员

5.4.1. 定义描述

5.4.2. 参数

MemberUpdateRequest

5.4.3. 返回参数

无

5.4.4. 使用示例

• 请求

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "memberIdentityId":"memberIdentityId1",
        "houseId": "houseId1234",
        "deviceList": [],
        "sceneList": [{
            "iotId": "iotid1",
            "sceneId": "",
            "operation": 1,
            "roomId": "9ddb8753c18b40afa285b32e89ac3746"
          }
        ],
        "roomList": [{
            "iotId": "",
            "sceneId": "",
            "operation": 1,
            "roomId": "9ddb8753c18b40afa285b32e89ac3746"
          }
        ]
    }
}

• 返回值

{
    "code": 200,
    "data": null,
    "message": "success",
    "localizedMsg": null,
  }

6. 通用服务

6.1. 获取设备消息列表

查询当前用户的消息记录

6.1.1. 定义描述

6.1.2. 请求参数

6.1.3. 返回值

• 示例结果

{
  "code": 200,
  "date": {
    "count": 1,
    "data": [
      {
        "appKey": 333,
        "body": "body3",
        "deviceType": "iOS",
        "extData": {
          "device": {
            "icon": "icon1"
          }
        },
        "gmtCreate": 1521695481000,
        "gmtModified": 1521695481000,
        "id": 3,
        "messageId": "m3",
        "messageType": "device",
        "scopeId": "s3",
        "target": "ACCOUNT",
        "targetValue": "a3",
        "tenantId": "t3",
        "title": "title3",
        "type": "NOTICE"
      }
    ]
  },
  "message": "success"
}

6.2. 产生分享二维码

6.2.1. 定义描述

6.2.2. 请求参数

bizType对应的content格式

6.2.3. 返回值

6.2.4. bizType说明

6.2.5. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "bizType": "HOUSE_SHARE",
        "houseIds":["xxxx"]
    }
}

• 返回示例

{
    "code":200,
    "data":{
        "qrCode":"http://homelink.aliyun.com?bizType=HOUSE_DELIVERY&qrCode=xxx",
        "content":{
                    "roomInfo":[{"roomName":"客厅", "deviceCount":5}], 
                    "sceneCount":5
        }
    },
    "message":"success"
}

6.3. 解析二维码

6.3.1. 定义描述

6.3.2. 入参

6.3.3. 返回值

6.3.4. 示例

• 请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "qrCode":"http://homelink.aliyun.com?bizType=HOUSE_DELIVERY&qrCode=xxx"
    }
}

• 返回示例

{
    "code":200,
    "data":{
        "qrCode":"http://homelink.aliyun.com?bizType=HOUSE_DELIVERY&qrCode=xxx",
        "content":{
                    "roomInfo":[{"roomName":"客厅", "deviceCount":5}], 
                    "sceneCount":5
        }
    },
    "message":"success"
}