Skip to content

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 NameParameter DescriptionRequest TypeRequiredData Typeschema
sceneIdScene IDbodytruestring
Authorizationheaderfalsestring
fidFamily ID, required when home mode is enabled, otherwise notbodyfalsestring

Response Status:

Status CodeDescriptionschema
200OKApiResult«ExecutionResultCO»
201Created
401Unauthorized
403Forbidden
404Not Found

Response Parameters:

Parameter NameParameter DescriptionTypeschema
codeinteger(int32)integer(int32)
dataExecutionResultCOExecutionResultCO
  callTypeCall methodstring
  executeResultExecution result. Success: true, Failure: falseboolean
  executeTimeExecution timeinteger(int64)
  executionIdExecution record IDinteger(int64)
  failActionListFailure reasonsarrayExecuteFailedCO
    deviceKeystring
    deviceNamestring
    deviceTypeinteger
    logoImagestring
    productKeystring
    reasonstring
  failCountFailure countAtomicIntegerAtomicInteger
    andDecrementinteger
    andIncrementinteger
  successCountSuccess countAtomicIntegerAtomicInteger
    andDecrementinteger
    andIncrementinteger
extMsgstring
msgstring

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": ""
}