call.doorbell.distance (Read doorbell detection distance)
call.doorbell.distance: Read doorbell detection distance
call.doorbell.distance · Device scope · Permission Talk
What it does
Reads doorbell detection distance on the device. 0 near, 1 medium, 2 far.
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.doorbell.distance"] |
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.doorbell.distance"
]
}
}
Response data fields
The value is in result.data.properties["call.doorbell.distance"].
| Value | Description |
|---|---|
0 | Near |
1 | Medium |
2 | Far |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"call.doorbell.distance": "0"
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.