ptz.linkage.enabled (Read gun-ball linkage switch)
ptz.linkage.enabled: Read gun-ball linkage switch
ptz.linkage.enabled · Device scope · Permission Ptz
What it does
Reads the device-scope gun-ball linkage master switch (multi-sensor enable). 0 off, 1 on. Device scope—do not send channelId; specify the channel for manual linkage in inputData.chan on Manual gun-ball linkage.
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 PTZ permission. A bound sub-user does not. A sub-account needs Ptz.
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 | ["ptz.linkage.enabled"] |
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": [
"ptz.linkage.enabled"
]
}
}
Response data fields
The value is in result.data.properties["ptz.linkage.enabled"](enum 0 off, 1 on).
| Value | Description |
|---|---|
0 | Off |
1 | On |
In JSON, enums may be numbers or strings (for example
1or"1")—follow the actual device response.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"ptz.linkage.enabled": 1
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.