call.session.ringVolume (Read call ring volume)
call.session.ringVolume: Read call ring volume
call.session.ringVolume · Device scope · Permission Talk
What it does
Reads call ring volume level on the device (std_callVolume/166800). text enum 1–5: higher index usually means louder (matches device/App volume steps). Do not use deprecated alias call.session.level.
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 talk permission. A bound sub-user does not. A sub-account needs Talk. See Permission codes and capability share_auth_code for shared devices.
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 | ["call.session.ringVolume"] |
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": [
"call.session.ringVolume"
]
}
}
Response data fields
The value is in result.data.properties["call.session.ringVolume"].
| Value | Description |
|---|---|
1 | Ring volume level 1 (minimum) |
2 | Ring volume level 2 |
3 | Ring volume level 3 |
4 | Ring volume level 4 |
5 | Ring volume level 5 (maximum) |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"call.session.ringVolume": "1"
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.