ptz.linkage.invoke (Manual gun-ball linkage)

ptz.linkage.invoke: Manual gun-ball linkage

ptz.linkage.invoke · Device scope · Permission Ptz

What it does

Runs manual gun-ball linkage on this channel. Inputs chan, x, y. One invoke runs once.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

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.A timeout does not mean the operation did not run.

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`
`serviceId`	String	yes	`ptz.linkage.invoke`
`inputData`	Object	yes	See table below

Name	Description	Type	Required	Values
`chan`	Channel. Range 0–255, step 1.	`int`	yes	`0`–`255`, step `1`
`x`	X coordinate. Range 0–8192, step 1.	`int`	yes	`0`–`8192`, step `1`
`y`	Y coordinate. Range 0–8192, step 1.	`int`	yes	`0`–`8192`, step `1`

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",
 "serviceId": "ptz.linkage.invoke",
 "inputData": {
 "chan": 0,
 "x": 4096,
 "y": 4096
 }
 }
}

Response data fields

Output is in result.data.outputData. Empty output is {}.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {}
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Gun-ball linkage