调用该接口创建设备的预约定时场景。预约定时场景与设备相关联,因此不能使用/scene/update和/living/scene/switch等接口来更新、启停。如有这方面需要,请使用/scene/timing/update接口。同时不支持手机消息推送action。
路径 | /scene/timing/create |
版本号 | 1.0.5 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
associatedId | String | 是 | test*****tId | 场景关联的ID。可传入设备ID、控制组ID。传入设备ID则定时与设备关联;传入控制组ID则定时与控制组关联。 |
idType | String | 是 | DEVICE | 场景关联ID的类别。可传入:DEVICE(表示定时属于设备);CONTROL_GROUP(表示定时属于控制组)。 |
enable | Boolean | 是 | 是否启用场景。 | |
name | String | 是 | 测试云端预约定时 | 场景名称。不能为空,最长不超过 64 个字符。 |
icon | String | 是 | http://www.aliyundoc.com/***.png | 场景图标链接。 |
description | String | 否 | 这是一个云端定时场景 | 对场景的描述。 |
triggers | Struct | 否 | {"items":[{"params":{"cron":"0 30 9 9 2 ? 2020","cronType":"quartz_cron","timezoneID":"Asia/Shanghai"},"uri":"trigger/timer"}],"uri":"logical/or"} | 场景的触发器。 |
conditions | Struct | 否 | {} | 场景的过滤条件。 |
actions | List | 是 | [{"params":{"iotId":"testDeviceIotId","propertyName":"PowerSwitch","propertyValue":1},"uri":"action/device/setProperty"}] | 场景的执行动作,不可为空。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | String |
返回的场景ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.5",
"iotToken": "token"
},
"params":{
"associatedId": "test*****tId",
"idType": "DEVICE",
"enable": "value2",
"name": "测试云端预约定时",
"icon": "http://www.aliyundoc.com/***.png",
"description": "这是一个云端定时场景",
"triggers":{
"items":[
{
"params":{
"cron": "0 30 9 9 2 ? 2020",
"cronType": "quartz_cron",
"timezoneID": "Asia/Shanghai"
},
"uri": "trigger/timer"
}
],
"uri": "logical/or"
},
"conditions":{},
"actions":[
{
"params":{
"iotId": "testDeviceIotId",
"propertyName": "PowerSwitch",
"propertyValue":1
},
"uri": "action/device/setProperty"
}
]
}
}
正常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code":200,
"message":"success",
"data":"testSceneId"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}