调用该接口在家中创建场景。平台提供家空间管理服务,可调用相关API搭建自有App的家空间模型。场景服务也对家空间进行了相应支持,提供了管理家中场景的能力。您一旦使用家空间服务为App用户创建了家,App用户之前创建的场景就会归属于这个家下。此时,App用户需要使用家场景接口方可管理场景。/scene/create和/scene/info/get不能访问家空间中的场景。
路径 | /living/scene/create |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
catalogId | String | 是 | 0 | 用于对场景进行分类。0(表示手动场景,只包含action场景),1(表示自动场景,包含Trigger和Condition的场景)。 |
enable | Boolean | 是 | true | 是否启用场景。取值为:true(表示启用);false(表示停用)。 |
name | String | 是 | 测试场景 | 场景的名称。 |
description | String | 否 | 这是一个测试场景 | 对场景的描述。 |
icon | String | 是 | http://www.test.com/xxx.png | 场景图标的下载链接。 |
iconColor | String | 否 | #FFFFFF | 场景图标颜色。 |
triggers | Struct | 否 | {} | IFTTT 规则下场景的触发器。 |
conditions | Struct | 否 | {} | IFTTT 规则下场景的条件。 |
caConditions | List | 否 | [] | CA规则下场景的条件。 |
actions | List | 是 | [] | 场景触发时所需执行的动作。 |
sceneType | String | 否 | IFTTT | 场景规则的分类,支持IFTTT和CA。 |
mode | String | 否 | all | 条件的模式。CA 规则下此字段有效。取值为:all (表示caConditions 中的条件全部满足时, 才会执行action中的内容);any(caConditions 中的任何一个条件被满足,就会执行action中的内容)。 |
homeId | String | 是 | 123 | 场景所在家的 ID,生活物联网平台赋予家的唯一标识符。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | String |
返回的场景ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1",
"iotToken": "token"
},
"params":{
"catalogId": "0",
"enable":true,
"name": "测试场景",
"description": "这是一个测试场景",
"icon": "http://www.test.com/xxx.png",
"iconColor": "#FFFFFF",
"triggers":{},
"conditions":{},
"caConditions":[],
"actions":[],
"sceneType": "IFTTT",
"mode": "all",
"homeId": "123"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "1234"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}