Appearance
Execute Scene
Interface Address:/v2/cep/enduserapi/sceneExecute
Request Method:POST
Request Data Type:application/json
Response Data Type:*/*
Interface Description:Execute Scene
Request Parameters:
Parameter Name | Parameter Description | Request Type | Required | Data Type | schema |
---|---|---|---|---|---|
sceneId | Scene ID | body | true | string | |
Authorization | header | false | string | ||
fid | Family ID, required when home mode is enabled, otherwise not | body | false | string |
Response Status:
Status Code | Description | schema |
---|---|---|
200 | OK | ApiResult«ExecutionResultCO» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Response Parameters:
Parameter Name | Parameter Description | Type | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | ExecutionResultCO | ExecutionResultCO | |
callType | Call method | string | |
executeResult | Execution result. Success: true, Failure: false | boolean | |
executeTime | Execution time | integer(int64) | |
executionId | Execution record ID | integer(int64) | |
failActionList | Failure reasons | array | ExecuteFailedCO |
deviceKey | string | ||
deviceName | string | ||
deviceType | integer | ||
logoImage | string | ||
productKey | string | ||
reason | string | ||
failCount | Failure count | AtomicInteger | AtomicInteger |
andDecrement | integer | ||
andIncrement | integer | ||
successCount | Success count | AtomicInteger | AtomicInteger |
andDecrement | integer | ||
andIncrement | integer | ||
extMsg | string | ||
msg | string |
Response Example:
javascript
{
"code": 0,
"data": {
"callType": "",
"executeResult": true,
"executeTime": 0,
"executionId": 0,
"failActionList": [
{
"deviceKey": "",
"deviceName": "",
"deviceType": 0,
"logoImage": "",
"productKey": "",
"reason": ""
}
],
"failCount": {
"andDecrement": 0,
"andIncrement": 0
},
"successCount": {
"andDecrement": 0,
"andIncrement": 0
}
},
"extMsg": "",
"msg": ""
}