ptz.aim.relative (Move by speed)

ptz.aim.relative: Move by speed

ptz.aim.relative · Channel scope · Permission Ptz

What it does

Moves this channel PTZ by speed. One invoke runs once. Whether horizontal/vertical/zoom/duration are required depends on the device ident (for example TwoLR has no vertical); check ptz.aim.relative field specs in device.capability.list first.

Request URL

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

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. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008. 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`
`channelId`	String	yes	Channel ID; `"0"` is common on IPCs
`serviceId`	String	yes	`ptz.aim.relative`
`inputData`	Object	yes	See table below

Name	Description	Type	Required	Values
`horizontal`	Horizontal speed [-1~1]; negative left, positive right.	`text`	yes	string
`vertical`	Vertical speed [-1~1]; negative down, positive up.	`text`	yes	string
`zoom`	Zoom factor [-1~1]; negative down, positive up.	`text`	yes	string
`duration`	Duration. Range 1–999999, step 1, unit ms.	`int`	yes	`1`–`999999`, step `1`, unit ms

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",
 "channelId": "0",
 "serviceId": "ptz.aim.relative",
 "inputData": {
 "horizontal": "0.5",
 "vertical": "0",
 "zoom": "0",
 "duration": 1000
 }
 }
}

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.

PTZ speed get/set · Move by step · controlMovePTZ (legacy operation 0–10) · PTZ movement