调用该接口获取用户的场景详情。
路径 | /scene/info/get |
版本号 | 1.0.5 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
sceneId | String | 是 | 场景的ID。生活物联网平台赋予场景的唯一标识符。 | |
groupId | String | 否 | 场景类型。0 (表示手动场景即 App 上的 “场景”);1(表示自动场景,即 App 上的 “自动化”);null(表示旧版场景)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应的结果。 |
|
id | String |
场景的ID。生活物联网平台赋予场景的唯一标识符。 |
|
name | String |
场景的名称。 |
|
description | String |
对场景的描述。 |
|
enable | Boolean |
APP上的场景开关。true(表示打开,场景可以正常被触发执行);false(表示关闭,即便达到触发条件,场景也不会执行)。 |
|
icon | String |
场景图标。 |
|
iconColor | String |
场景图标的颜色。 |
|
caConditionsJson | JSON |
Since场景2.0,CA规则Condition内复杂对象的Json 序列化,用于前端展示。 |
|
triggersJson | String |
IFTTT规则-Trigger内复杂对象的Json序列化,用于前端展示。 |
|
actionsJson | JSON |
Action内复杂对象的Json 序列化,用于前端展示。 |
|
conditionsJson | String |
IFTTT规则Condition内复杂对象的Json序列化,用于前端展示。 |
|
sceneType | String |
场景规则,IFTTT、CA。缺省值为IFTTT。 |
|
mode | String |
CA规则的模式。all(表示caConditions 中的条件全部满足时, 才会执行action中的内容);any(表示caConditions 中的任何一个条件被满足,就会执行action中的内容)。 |
|
valid | Boolean |
场景是否有效。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.5",
"iotToken": "token"
},
"params":{
"sceneId": "value0",
"groupId": "value1"
}
}
正常返回示例
JSON
格式
{}
异常返回示例
JSON
格式
{}