image.night.mode (Read night vision mode)
image.night.mode: Read night vision mode
image.night.mode · Channel scope · Permission Config
What it does
Reads the night vision mode on this channel. Send enum values, not label text. The table below is the full set; supported modes on a device follow device.capability.list specs.list.
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
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | Administrator, sub-user, or sub-account accessToken |
deviceId | String | yes | Device serial number |
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
channelId | String | yes | Channel ID; "0" is common on IPCs |
properties | Array | yes | ["image.night.mode"] |
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.mode"
]
}
}
Response data fields
The value is in result.data.properties["image.night.mode"].
Send enum values, not label text. Which modes this device supports is defined by device.capability.list.
| Value | Description |
|---|---|
0 | Smart night vision |
1 | Full-color night vision |
2 | Infrared night vision |
3 | Night vision off |
4 | Custom mode (follow capability discovery / model docs for extra fields) |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"image.night.mode": 0
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.