ptz.cruise.get (Get cruise info)

ptz.cruise.get: Get cruise info

ptz.cruise.get · Channel scope · Permission Config

What it does

Device must support TimedCruise (ptz.cruise.plan may use RegularCruise); see Cruise overview. Reads cruise info for this channel. No inputs—inputData is {}. Returns cruiseModel, collection, and cruises. 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.cruise.get`
`inputData`	Object	conditional	No inputs: pass `{}`

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.cruise.get",
 "inputData": {}
 }
}

Response data fields

Output is in result.data.outputData.

Name	Description	Type	Required	Values
`collection`	Presets. Up to 100 entries.	`array`	no	Up to `100` entries
`collection.item.name`	Cruise point name.	`text`	no	string
`collection.item.stayTime`	Dwell time, unit s.	`enum`	no	`10`; `15`; `30`; `45`; `60`; `90`; `120`; `150`; `180`; `210`; `240`; `270`; `300`
`cruiseModel`	Cruise mode. 0 panorama, 1 preset.	`enum`	no	`0` panorama; `1` preset
`cruises`	Cruise time windows. Up to 100 entries.	`array`	no	Up to `100` entries
`cruises.item.beginTime`	Start time within the day, format THHmmss, e.g. T000000.	`text`	no	Format `THHmmss`, e.g. `T000000`
`cruises.item.endTime`	End time within the day, format THHmmss, e.g. T000000.	`text`	no	Format `THHmmss`, e.g. `T000000`
`cruises.item.period`	Effective weekdays.	`text`	no	Often 0–127 bitmap string (e.g. `"127"` for every day); set should match get format

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "collection": [
 {
 "name": "Living room",
 "stayTime": "10"
 }
 ],
 "cruiseModel": "0",
 "cruises": [
 {
 "beginTime": "T080000",
 "endTime": "T180000",
 "period": "127"
 }
 ]
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Cruise