调用该接口创建用户场景。
路径 | /scene/create |
版本号 | 1.0.5 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
enable | Boolean | 是 | 是否在创建时启用场景。true(表示启用);false(表示停用)。 | |
name | String | 是 | 用户给场景起的名称 | |
icon | String | 是 | 场景图标。 | |
triggers | Struct | 否 | {} | IFTTT 规则的触发对象。 |
conditions | Struct | 否 | {} | IFTTT规则的条件。 |
actions | List | 是 | [] | 动作对象。 |
uri | String | 是 | 逻辑节点。 | |
groupId | String | 否 | 场景类型。0 (表示手动场景即 App 上的 “场景”);1(表示自动场景,即 App 上的 “自动化”)。 | |
description | String | 否 | 对场景的描述,最大256字符。 | |
iconColor | String | 否 | 场景图标的颜色。 | |
sceneType | String | 否 | IFTTT or CA | 场景规则类型。可取值为:IFTTT和CA,为空时默认IFTTT。 |
mode | String | 否 | all or any | CA规则的模式。all(表示caConditions 中的条件全部满足时, 才会执行action中的内容);any(表示caConditions 中的任何一个条件被满足,就会执行action中的内容)。 |
caConditions | List | 否 | CA规则的Condition对象。 | |
uri | String | 否 | 逻辑节点。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int | 接口返回码。200表示成功。 |
|
message | String | 调用失败时,返回的出错信息。 |
|
localizedMsg | String | 本地语言的错误消息。 |
|
data | String | 返回新创建的场景ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.5",
"iotToken": "token"
},
"params":{
"enable": "value0",
"name": "value1",
"icon": "value2",
"triggers":{},
"conditions":{},
"actions":[],
"groupId": "value6",
"description": "value7",
"iconColor": "value8",
"sceneType": "IFTTT or CA",
"mode": "all or any",
"caConditions": "value11"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"data": "sceneId",
"message": "success"
}
异常返回示例
JSON
格式
{}