ptz.cruise.plan (Set cruise schedule)
ptz.cruise.plan: Set cruise schedule
ptz.cruise.plan · Channel scope · Permission Config
What it does
Device must support TimedCruise (ptz.cruise.plan may use RegularCruise); see Cruise overview. Sets the cruise schedule. When model=3, also send periods (each with period, beginTime, endTime). Out-of-range values are rejected, not clamped.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
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 write 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 |
properties | Object | yes | Key ptz.cruise.plan |
| Field | Type | Required | Values |
|---|---|---|---|
mode.model | enum | yes | 0 all day; 1 daytime only; 2 night only; 3 custom |
mode.data | int | yes | Weekday bit mask 0–255 |
periods | array | when model=3 | Up to 100 segments |
periods[].period | int | yes | 0–6 (Sun–Sat) |
periods[].beginTime | text | yes | THHmmss |
periods[].endTime | text | yes | THHmmss |
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",
"properties": {
"ptz.cruise.plan": {
"mode": { "model": 3, "data": 0 },
"periods": [
{ "period": 1, "beginTime": "T090000", "endTime": "T180000" }
]
}
}
}
}
Response data fields
On success, code is "0" and data is {}.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
Error codes
Gateway and device error codes are in Global return codes.