ptz.preset.set (Set preset)
ptz.preset.set: Set preset
ptz.preset.set · Channel scope · Permission Config
What it does
Device must support CollectionPoint and/or Preset (see Preset overview); follow device.capability.list. Sets a preset on this channel. Inputs name, stayTime (0–100 s), optional bCruise and cruiseName. 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 basic configuration permission. A bound sub-user does not. A sub-account needs Config. 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.preset.set |
inputData | Object | yes | See table below |
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
name | Preset name. | text | yes | string |
stayTime | Dwell seconds 0–100 for this invoke. Not the stay-time level index or cruise stayTime enum seconds. | int | yes | 0–100 |
bCruise | Include in cruise plan. 0 off, 1 on. | int | yes | 0 off; 1 on |
cruiseName | Optional unique cruise plan id. Valid when bCruise=true. | text | no | string |
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.preset.set",
"inputData": {
"name": "point1",
"stayTime": 30,
"bCruise": 1,
"cruiseName": "cruise1"
}
}
}
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.