场景服务2.0

更新时间：2019-09-07 00:24:20

提供一组客户端用户创建和配置自动化场景的接口，可以实现触发某些条件时，执行某些任务的功能，如当到达某个时间时、设备自动开启等功能。

场景自动化的创建、编辑、删除、查询

• 创建场景/自动化

• 更新场景/自动化

• 删除场景/自动化

• 获取场景/自动化详情

• 批量获取场景/自动化详情

• 查询所有场景+自动化列表

• 查询场景/自动化列表

• 改变场景自动化列表中的排序

触发条件和执行任务

• 获取支持trigger或condition或action的设备列表

• 获取设备的trigger或condition或action功能列表

• 获取设备的trigger或condition或action功能列表与tsl定义

• 向手机推送消息action

场景自动化的执行

• 执行场景

• 场景生效与失效

• 获取场景日志列表

• 获取失败日志详情

APP小组件

• 智能小组件查询场景

• 智能小组件添加场景

设备定时

• 创建设备定时

• 更新设备定时

• 删除设备定时

• 获取设备定时详情

• 查询设备定时列表

额外说明

• trigger、condition、caCondition以及action说明

• URL枚举

创建场景

定义描述

调整入参groupId必须存在，增加入参字段iconColor。

请求参数

注：action不能为空，trigger可以空，condition可以空，caCondition可以空
trigger对象，condition对象，caCondition对象以及action对象文档查看 链接

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.5",
        "iotToken": "token"
    },
    "params": {
        "enable": true,
        "icon": "https://gaic.alicdn.com/ztms/cloud-intelligence-icons/icons/scene_img_choice_icon_9.png",
        "groupId": "1",
        "mode": "all",
        "sceneType": "CA",
        "caConditions": [{
            "uri": "condition/timeRange",
            "params": {
                "beginDate": "08:00",
                "endDate": "07:00",
                "format": "HH:mm"
            }
        }, {
            "uri": "condition/device/property",
            "params": {
                "propertyName": "PowerSwitch",
                "compareValue": 1,
                "compareType": "==",
                "productKey": "a113CVGLO6k",
                "deviceName": "VD_ChYDyO70Gc"
            }
        }],
        "iconColor": "#19BBFF",
        "name": "向手机发送通知",
        "actions": [{
            "uri": "action/mq/send",
            "params": {
                "customData": {
                    "message": "电源开启了"
                },
                "msgTag": "IlopBusiness_CustomMsg"
            }
        }]
    }
}

返回示例

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

错误码

更新场景

定义描述

请求参数

Trigger对象，Condition对象，Action对象文档查看 链接

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
    "enable" : true,
    "iconColor" : "#DE4545",
    "reBind" : true,
    "mode" : "any",
    "caConditions" : [
      {
        "uri" : "condition\/timer",
        "params" : {
          "cron" : "33 10 * * 1,2,3,4",
          "cronType" : "linux"
        }
      }
    ],
    "sceneType" : "CA",
    "icon" : "http:\/\/gaic.alicdn.com\/ztms\/cloud-intelligence-icons\/icons\/scene_img_choice_icon_1.png",
    "sceneId" : "2420d2b561f244e7888dc1f93c54fc4e",
    "groupId" : "1",
    "name" : "10:27 周一 周二 - 电源开关 开启",
    "actions" : [
      {
        "uri" : "action\/device\/setProperty",
        "params" : {
          "iotId" : "uumR5a7euISb5g5YmC6J000101",
          "propertyName" : "PowerSwitch",
          "propertyValue" : 1
        }
      }
    ]
  }
}

返回示例

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

错误码

删除场景

定义描述

请求参数

返回参数

示例

请求示例

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

返回示例

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

错误码

查询场景列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "groupId": "1",
        "pageSize": 20,
        "pageNo": 1,
        "type": "ilop"
    }
}

返回示例

{
    "code": 200,
    "data": {
        "pageNo": 1,
        "pageSize": 20,
        "scenes": [{
            "description": "电热毯-hy-信噪比--127 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "260de82dd0cc484a80415a104691be22",
            "name": "电热毯",
            "status": 2,
             "iconColor":"#19BBFF",
            "valid":false,
            "groupId":"1"

        }, {
            "description": "light-hy-LightSwitch-1, shuijin-hy-WiFI_SNR--127 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "45dc6fc753d345b69b01d29f6974e5f7",
            "name": "凉宫",
            "status": 1,
              "iconColor":"#19BBFF",
            "valid":true,
            "groupId":"1"
        }, {
            "description": "fengsan-hy-PowerSwitch-关闭, light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "3ce63673e5164d49b0ec1f1367f2dc88",
            "name": "风扇灯0522",
            "status": 1,
              "iconColor":"#19BBFF",
            "valid":false,
            "groupId":"1"
        }, {
            "description": "light-hy-LightSwitch-1 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "5b4bdee4d1d5457081082ee522612f81",
            "name": "灯0522",
            "status": 2,
              "iconColor":"#19BBFF",
            "valid":false,
            "groupId":"1"
        }],
        "total": 4
    },
    "message": "success"
}

错误码

查询我的智能页面

定义描述

请求参数

返回参数

示例

请求示例

{
 "id": "1509086454180",
 "version": "1.0",
 "request": {
  "apiVer": "1.0.0",
  "iotToken": "token"
 },
 "params": {
 "pageNum": 1,
  "pageSize": 10
​ }
}

返回示例

{
 "code": 200,
 "data": {
    "scene0": {
        "total": 1,
        "scenes": [
            {
                "id": "",
                "name": "",
                "description": "",
                "enable": true,
                "icon": "",
                "iconColor": "",
                "groupId": "0",
                "valid": true
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "scene1": {
        "total": 0,
        "scenes": [],
        "pageNo": 1,
        "pageSize": 10
    } 
  },
 "message": "success"
}

错误码

请参考公共错误码

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

定义描述

请求参数

返回参数

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "type": "ilop",
        "groupId": null,
        "newOrders": [{
            "fromOrder": 1,
            "sceneId": "a596de546faf48b096410a80d9685d25",
            "toOrder": 2
        }, {
            "fromOrder": 2,
            "sceneId": "c1a8de4d6faa477bb6ec023003b473c3",
            "toOrder": 1
        }]
    }
}

返回实例

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

错误码

执行场景

定义描述

请求参数

返回参数

示例

请求实例

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

返回实例

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

错误码

获取场景日志列表

定义描述

请求参数

场景日志查询的方式：
场景日志需要指定一个查询的时间起点，定义为T1，后端会查从T1开始向前追溯15天的日志，即
[T1-15*3600*24, T1] 这个时间段之间的日志
故约定：App端打开日志查询的界面时，记录下页面打开的时间点作为T1，在后续的查询中，一直携带T1作为time。
如果页面要查看T1之后的某个时间点开始的Log，需要重新指定此时的时间点T2，并且把已查询到的结果全部删除掉，令pageNo=1，重新开始查询。

返回参数

示例

请求示例

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

返回示例

{
    "code": 200,
    "data": {
        "logs": [{
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000056576d52bf",
            "result": 0,
            "sceneId": "d5edf3a80e5c40d48aba0591b15e2028",
            "sceneName": "t时间设备",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000056577d52bf",
            "result": 0,
            "sceneId": "81eb22a299dd4262932365212d0993ce",
            "sceneName": "t时间",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000036575d52bf",
            "result": 0,
            "sceneId": "3f522eb034f842ba8d8e627612336709",
            "sceneName": "测",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270912000056578d52bf",
            "result": 0,
            "sceneId": "3202047e1e4a4af38e5c4ab66a757ee3",
            "sceneName": "t时间设备",
            "time": 1527091200000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15270549875871014d52bf",
            "result": 1,
            "sceneId": "70d90fe996964a718b42ec2997188911",
            "sceneName": "灯",
            "time": 1527054987000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269604322384548d3112",
            "result": 1,
            "sceneId": "5b4bdee4d1d5457081082ee522612f81",
            "sceneName": "灯0522",
            "time": 1526960432000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550384782579d3112",
            "result": 1,
            "sceneId": "70d90fe996964a718b42ec2997188911",
            "sceneName": "灯",
            "time": 1526955038000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550370082578d3112",
            "result": 1,
            "sceneId": "3c8bc0c09f4e411cb3d535598669741f",
            "sceneName": "两个灯0522",
            "time": 1526955037000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550356242576d3112",
            "result": 1,
            "sceneId": "70d90fe996964a718b42ec2997188911",
            "sceneName": "灯",
            "time": 1526955035000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550340772575d3112",
            "result": 1,
            "sceneId": "3c8bc0c09f4e411cb3d535598669741f",
            "sceneName": "两个灯0522",
            "time": 1526955034000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550326602573d3112",
            "result": 1,
            "sceneId": "70d90fe996964a718b42ec2997188911",
            "sceneName": "灯",
            "time": 1526955032000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550311612572d3112",
            "result": 1,
            "sceneId": "3c8bc0c09f4e411cb3d535598669741f",
            "sceneName": "两个灯0522",
            "time": 1526955031000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550296422570d3112",
            "result": 1,
            "sceneId": "70d90fe996964a718b42ec2997188911",
            "sceneName": "灯",
            "time": 1526955029000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269550281812569d3112",
            "result": 1,
            "sceneId": "3c8bc0c09f4e411cb3d535598669741f",
            "sceneName": "两个灯0522",
            "time": 1526955028000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269184000015774d3112",
            "result": 0,
            "sceneId": "81eb22a299dd4262932365212d0993ce",
            "sceneName": "t时间",
            "time": 1526918400000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269184000015772d3112",
            "result": 0,
            "sceneId": "3f522eb034f842ba8d8e627612336709",
            "sceneName": "测",
            "time": 1526918400000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269184000015771d3112",
            "result": 0,
            "sceneId": "3202047e1e4a4af38e5c4ab66a757ee3",
            "sceneName": "t时间设备",
            "time": 1526918400000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15269184000015773d3112",
            "result": 0,
            "sceneId": "d5edf3a80e5c40d48aba0591b15e2028",
            "sceneName": "t时间设备",
            "time": 1526918400000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15268970952516329d3112",
            "result": 1,
            "sceneId": "70d90fe996964a718b42ec2997188911",
            "sceneName": "灯",
            "time": 1526897095000
        }, {
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "0bc19f5d15268829550571368d3112",
            "result": 1,
            "sceneId": "9fda7bc446e44ccc8edf4c0e39f89305",
            "sceneName": "两个灯",
            "time": 1526882955000
        }],
        "pageNo": 1,
        "pageSize": 20,
        "total": 62
    },
    "message": "success"
}

错误码

请参考公共错误码

获取失败日志详情

定义描述

请求参数

返回参数

示例

请求示例

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

应答示例

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

错误码

获取场景详情

定义描述

请求参数

返回参数

创建设备定时

定义描述

注：预约定时场景与设备相关联，因此不能使用 /scene/update, /living/scene/switch 等接口来更新、启停。如有这方面需要，请使用 /scene/timing/update 接口。同时不支持手机消息推送 action。

请求参数

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

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "actions": [{
            "params": {
                "compareValue": 1,
                "iotId": "zjoOvFZWenq1xdxRyvcI0010c4dc00",
                "compareType": ">",
                "propertyName": "Qu0wChfloat",
                "propertyValue": 1
            },
            "uri": "action/device/setProperty"
        }],
        "iotId":"zjoOvFZWenq1xdxRyvcI0010c4dc00",
        "enable": true,
        "icon": "https://g.aliplus.com/scene_icons/default.png",
        "name": "一样",
        "triggers": {
            "params": {},
            "items": [{
                "params": {
                    "cron": "1 1 * * *",
                    "cronType": "linux",
                    "timezoneID": "Asia/Shanghai"
                },
                "uri": "trigger/timer"
            }],
            "uri": "logical/or"
        }
    }
}

返回示例

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

错误码

更新设备定时

定义描述

请求参数

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

返回参数

示例

请求示例

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

返回示例

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

错误码

删除设备定时

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "sceneId": "0c96536b09404a50ac6645c5306a6657",
        "iotId": "gaI0CRK2GV7KmDVc8gk300109b3700"
    }
}

返回示例

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

错误码

获取设备定时详情

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "sceneId": "260de82dd0cc484a80415a104691be22",
        "iotId": "gaI0CRK2GV7KmDVc8gk300109b3700"
    }
}

返回示例

{
    "code": 200,
    "data": {
        "actions": [{
            "params": {
                "compareValue": -127,
                "localizedProductName": "电热毯-hy",
                "iotId": "SY7a6IDsvT0m2tTdzm0z00103d0c00",
                "compareType": "==",
                "propertyName": "WiFI_SNR",
                "localizedPropertyName": "信噪比",
                "deviceNickName": "电热毯-hy",
                "propertyValue": -127,
                "localizedCompareValueName": "-127",
                "productKey": "b1DQZAMjUql",
                "propertyItems": {
                    "WiFI_SNR": -127
                },
                "deviceName": "hyhyhy4"
            },
            "uri": "action/device/setProperty",
            "status": 0
        }],
        "enable": true,
        "icon": "https://g.aliplus.com/scene_icons/default.png",
        "name": "电热毯",
        "sceneId": "260de82dd0cc484a80415a104691be22",
        "status": 2
    },
    "message": "success"
}

错误码

查询设备定时列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2",
        "iotToken": "token"
    },
    "params": {
        "pageSize": 20,
        "pageNo": 1,
        "iotId": "zjoOvFZWenq1xdxRyvcI0010c4dc00"
    }
}

返回示例

{
    "code": 200,
    "data": {
        "pageNo": 1,
        "pageSize": 20,
        "scenes": [{
            "description": "电热毯-hy-信噪比--127 ",
            "enable": true,
            "icon": "https://g.aliplus.com/scene_icons/default.png",
            "id": "260de82dd0cc484a80415a104691be22",
            "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": "45dc6fc753d345b69b01d29f6974e5f7",
            "name": "凉宫",
            "status": 1
        }],
        "total": 2
    },
    "message": "success"
}

错误码

trigger与condition、caConditions条目树节点对象的定义

当前triggers，conditions、caConditions支持单个叶子结点或者在一个逻辑节点下挂多个叶子结点
actions是叶子结点列表

URL枚举

逻辑节点支持的URL

triggers支持的URL

conditions支持的URL

caCondition支持的URL

actions支持的URL

叶子结点参数定义

/trigger/timer

trigger/device/property

trigger/device/event

condition/timeRange

condition/device/property

action/scene/trigger

action/device/invokeService

action/device/setProperty

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "sceneId": "260de82dd0cc484a80415a104691be22",
        "groupId": "1"
    }
}

返回示例

{
    "code": 200,
    "data": {
    "mode":"all",
    "valid":false,
    "sceneType":"CA",
    "enable":true,
    "name":"日常风扇-工作模式 - 睡眠风",
    "icon":"https://gaic.alicdn.com/ztms/cloud-intelligence-icons/icon/scene_img_choice_icon_7.png",
    "iconColor":"#23CEC5",
    "actionsJson":[
        "{"params":{"iotId":"PTQeXooisgH3qrzW9TLb000101","localizedProductName":"日常风扇","propertyName":"WorkMode","localizedPropertyName":"工作模式","deviceNickName":"日常风扇","propertyValue":3,"localizedCompareValueName":"睡眠风","productKey":"a1RWKbzRwpu","propertyItems":{"WorkMode":3},"deviceName":"VD_soyCyFnIhH"},"uri":"action/device/setProperty","status":0}"
    ],
    "id":"4dc9c2f7b39a477cad675e5a8451a254",
    "caConditionsJson":[
        "{"params":{"compareValue":1,"localizedProductName":"日常风扇","iotId":"PTQeXooisgH3qrzW9TLb000101","compareType":"==","propertyName":"PowerSwitch","localizedPropertyName":"电源开关","deviceNickName":"日常风扇","localizedCompareValueName":"开启","productKey":"a1RWKbzRwpu","deviceName":"VD_soyCyFnIhH"},"uri":"condition/device/property"}"
    ]
},
    "message": "success"
}

trigger/device/event请求示例

{
    "uri":"trigger/device/event",
    "params":{
        "productKey": "test_pk",
        "deviceName": "test_dn",
        "eventCode": "temp_warning",
        "propertyName": "temp",
        "compareType": ">",
        "compareValue": 30
    }
}

错误码

场景生效与失效

定义描述

请求参数

返回参数

无

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "sceneId": "0c96536b09404a50ac6645c5306a6657",
        "enable": true
    }
}

返回示例

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

获取支持trigger或condition或action的设备列表

定义描述

请求参数

返回参数

data 列表结构

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
        "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"
}

错误码

请参考公共错误码

获取设备的trigger或condition或action功能列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "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"
}

错误码

请参考公共错误码

获取设备的trigger或condition或action功能列表与tsl定义

定义描述

请求参数

返回参数

simplifyAbilityDTOs结构

示例

请求示例

{
    "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"
}

错误码

请参考公共错误码

批量获取场景详情

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": 
  {"sceneIdList":["b8fe2abac19e498ea8e367a026b76c31"]}
}

返回示例

{
  "code":200,
  "data":
  [
  {"sceneType":"IFTTT",
  "name":"主灯开关 开启 - 灯模式 mono - 开启",
  "icon":"https://img.alicdn.com/tfs/TB10G8tPrvpK1RjSZFqXXcXUVXa-144-144.png",
  "sceneId":"b8fe2abac19e498ea8e367a026b76c31",
  "sceneSwitch":1,
  "triggers":"{\"params\":{},\"items\":[{\"params\":{\"eventCode\":\"\",\"compareValue\":1,\"iotId\":\"z8nqhWz3kZWdDGjp6SFY000101\",\"compareType\":\"==\",\"propertyName\":\"LightSwitch\",\"propertyValue\":1,\"productKey\":\"a1B0kMs35NW\",\"deviceName\":\"z8nqhWz3kZWdDGjp6SFY\"},\"uri\":\"trigger/device/property\"}],\"uri\":\"logical/or\"}",
  "conditions":"{\"params\":{},\"items\":[{\"params\":{\"eventCode\":\"\",\"compareValue\":0,\"iotId\":\"z8nqhWz3kZWdDGjp6SFY000101\",\"compareType\":\"==\",\"propertyName\":\"LightMode\",\"propertyValue\":0,\"productKey\":\"a1B0kMs35NW\",\"deviceName\":\"z8nqhWz3kZWdDGjp6SFY\"},\"uri\":\"condition/device/property\"}],\"uri\":\"logical/and\"}",
  "actions":"[{\"params\":{\"switchStatus\":1,\"automationRuleId\":\"503f5c75af4348f28d424a6cd520ceed\"},\"uri\":\"action/automation/setSwitch\"}]"}
  ],
  "id":"1509086454180"
}

向手机推送消息action

定义描述

| path | 描述 |

| --- | --- |
| /action/mq/send | 向手机推送消息action |

请求参数

返回参数

无

请求示例

"actions": [
    {
        "uri":"action/mq/send",
        "params":{
            "customData":{
                "message":"电源开启了"
            },
            "msgTag":"IlopBusiness_CustomMsg"
        }
    }
]

返回示例

无

错误码

请参考公共错误码

智能小组件查询场景

定义描述

请求参数

无

返回参数

请求示例

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

返回示例

{
    "code": 200,
    "message": "success"
      "data":[{
        "id": "d5edf3a80e5c40d48aba0591b15e2028",
        "iconColor": "#19BBFF",
        "name": "向手机发送通知",
        "description": " 描述 ",
        "enable": true
    },
    {
        "id": "debf2d332cbf48569d42b430d51496c2",
        "iconColor": "#FFBBFF",
        "name": "开灯",
        "description": "描述",
        "enable": false
    }
]
}

智能小组件添加场景

定义描述

请求参数

无

返回参数

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
      "sceneIds":["d5edf3a80e5c40d48aba0591b15e2028","debf2d332cbf48569d42b430d51496c2"]
    }
}

返回示例

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