調用該接口創建用戶場景。
路徑 | /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
格式
{}