getNightVisionMode (getNightVisionMode: Query device night vision mode configuration)

getNightVisionMode: getNightVisionMode: Query device night vision mode configuration

Deprecated: Use Night vision (image.night.mode). This legacy HTTP page is retained for existing integrations.

Function details

Query the night vision mode configuration of the device, including the currently enabled mode and the set of modes supported by the device.

Note: Night vision mode requires the device to have NVM capability set

Request address

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

Request format

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

The minimum permissions required for the 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	Parameter description
token	String	Yes	Administrator or sub-account accessToken
deviceId	String	Yes	Device serial number
channelId	String	No	Channel ID. Optional; when omitted, the platform uses the default channel for the device (same as `checkChannelOnline`).

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_00006acr3456d12312d3grf60147de7ec",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0"
 }
}

Return data field description

Field	Type	Description
mode	String	The current night vision mode of the device
modes	Array	The night vision mode supported by the device: Intelligent/FullColor/Infrared/Off/LowLight/SmartLowLight, which respectively indicate smart night vision/full color night vision/infrared night vision/off/low-light night vision/intelligent low-light night vision

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data": {
 "mode": "FullColor",
 "modes": ["Intelligent", "FullColor", "Infrared", "Off", "LowLight", "SmartLowLight"]
 }
 },
 "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.