setDeviceCameraStatus (Set Device Camera Status - Set Device Enable Switch - Imou Open Platform)

setDeviceCameraStatus: Set Device Camera Status - Set Device Enable Switch - Imou Open Platform

Legacy HTTP retained: New integrations can use Capability usage (device.property.set) for the related capability. The two interfaces are not a one-to-one replacement. This HTTP is multiplexed across several registry leaves and is not a one-to-one replacement.

Function details

Set the device enable switch.

Note: Only devices with accessType= in the device details are supported

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/setDeviceCameraStatus

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Minimum permissions required for sub-account token request

The sub-account accessToken policy must include Config; channel resource URI is cam:{deviceId}:{channelId}. See Permission codes.

Incoming parameter description

Parameter name	Parameter type	Required or not	Legal value	Parameter description
token	String	Yes		Administrator or sub-account accessToken
deviceId	String	Yes		Device serial number
channelId	String	No	If the enableType is device-level enable, there is no need to pass the channel number, and the channel-level enable needs to pass the channel number	channel number
enableType	String	Yes	Please refer to "Device Capability Switch Description" for details, the first letter is lowercase	Device enable type
enable	Boolean	yes	true: enable enable; false: disable enable	Is it effective (on or off)

Sample input

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603353544,
 "nonce":"de9af038-97ed-4742-881d-6aa23effb4fc"
 },
 "id":"1254dfe5-bd59-4b8d-8a11-7ab4ba84def3",
 "params":{
 "enableType":"closeCamera",
 "enable":true,
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

No data returned

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0"
 },
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.