audio.volume.level (Set volume level)
audio.volume.level: Set 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. Set the device volume level. Actual writable values are subject to the ident of the ability discovery binding (volume5 "1" ~ "5", device_volume_enum -1 "/" 0 " ~ " 2 ", lock_volume " 0 " ~ " 3 ", see volume). The following table is an example of volume5. Out of bounds rejection, not truncation.
Request address
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
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. A write timeout does not mean that it was not executed.
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 | Object | yes | key is audio.volume.level (string enum); see Get Volume Properties |
properties["audio.volume.level"] | Description (volume5) |
|---|---|
1 | Level 1 |
2 | Level 2 |
3 | Level 3 |
4 | Level 4 |
5 | Level 5 |
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": "3"
}
}
}
# # # Returns a description of the data field
On success, code is "0" and data is {}.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
Error Code
Gateway and device error codes are in Global return codes.