media.display.autoOff (Read auto screen-off timeout)
media.display.autoOff: Read auto screen-off timeout
media.display.autoOff · Device scope · Permission Config
What it does
Reads auto screen-off timeout. 0 never; other values are seconds (e.g. 10/15/30/60/120/180/240/300).
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.
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 |
properties | Array | yes | ["media.display.autoOff"] |
Common request fields and the signature are in Development specification.
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",
"properties": [
"media.display.autoOff"
]
}
}
Response data fields
The value is in result.data.properties["media.display.autoOff"]. String enum (JSON values such as "0", "30", …).
| Value | Description |
|---|---|
"0" | Never |
"30" | 30 s |
"60" | 1 min |
"120" | 2 min |
"180" | 3 min |
"240" | 4 min |
"300" | 5 min |
"10" | 10 s |
"15" | 15 s |
"20" | 20 s |
"25" | 25 s |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"media.display.autoOff": "0"
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.
