ptz.aim.step (Move by step)
ptz.aim.step: Move by step
ptz.aim.step · Channel scope · Permission Ptz
What it does
Unlike Move by speed: one step in a direction without continuous speed. One invoke runs once.
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.step |
inputData | Object | yes | See table below |
Unlike Move by speed: moves one step in a direction without continuous speed.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
operator | PTZ direction. | enum | yes | Often 1 left, 2 right, 3 up, 4 down; eight-way models add diagonals (e.g. 13/14/23/24); TwoLR only 1/2. Follow ptz.aim.step enum in device.capability.list. |
zoom | Zoom direction. | enum | yes | 1 ZoomWide; 2 ZoomTele |
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.step",
"inputData": {
"operator": "1",
"zoom": "1"
}
}
}
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.