Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
        • Anti-flicker
        • Night vision
          • image.night.enabled (Read night vision switch)
          • image.night.enabled (Set night vision switch)
          • image.night.mode (Read night vision mode)
          • image.night.mode (Set night vision mode)
          • image.night.switchMode (Read night vision switch mode)
          • image.night.switchMode (Set night vision switch mode)
          • image.night.plan (Read scheduled night vision plan)
          • image.night.plan (Set scheduled night vision plan)
        • Image orientation
        • Video standard
        • WDR
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

image.night.enabled (Read night vision switch)

image.night.enabled: Read night vision switch

image.night.enabled · Channel scope · Permission Config

What it does

enabled is for capability model devices. night.modeor legacy APIs—not this leaf. Reads the night vision switch on this channel.0off,1` on.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008.

Request parameters

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel ID; "0" is common on IPCs
propertiesArrayyes["image.night.enabled"]

Common request fields and signing: Signing and Common request payload.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "properties": [
 "image.night.enabled"
 ]
 }
}

Response data fields

The value is in result.data.properties["image.night.enabled"].

ValueDescription
0Off
1On

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "image.night.enabled": 1
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set night vision switch · Night vision

image.flicker.config (Set anti-flicker config)
image.night.enabled (Set night vision switch)