audio.volume.level (Read volume level)
audio.volume.level: Read volume level
audio.volume.level · Device scope · Permission Config
Feature details
Some models use string enum "1"–"5"; others use JSON number 1–5—follow read-back. Read the device volume level. The Open API unifiesaudio.volume.level; The set of values is based on the ident of the capability discovery binding (see the volume tertiary description). The following table shows the volume5 fifth gear model; the sample"3"also belongs to this file.
Request address
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get
Minimum permission
Administrators do not need permission to operate self-bound devices. Basic configuration permission is required to operate the shared device. Child user binding is not required. Sub-account requires 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 | ["audio.volume.level"] |
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": [
"audio.volume.level"
]
}
}
# # # Returns a description of the data field
The value is in result.data.properties["audio.volume.level"].
| Value | Description (volume5 / 103000) |
|---|---|
1 | Volume level 1 (lowest on five-level models) |
2 | Volume level 2 |
3 | Volume level 3 |
4 | Volume level 4 |
5 | Volume level 5 (highest on five-level models) |
device_volume_enum (15400): "-1" Mute, "0" ~ "2". lock_volume (116100): "0" ~ "3". Other idents are subject to ability discovery.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"audio.volume.level": "3"
}
}
}
}
Error Code
Gateway and device error codes are in Global return codes.