getTimedCruisePlan (getTimedCruisePlan - Query the timing cruise plan of device - Imou Open Platform)

getTimedCruisePlan: getTimedCruisePlan - Query the timing cruise plan of device - Imou Open Platform

Legacy HTTP retained: New integrations can use Cruise (ptz.cruise.*) for the related capability. The two interfaces are not a one-to-one replacement. Filename, actual HTTP method, and registry names are not the same; not a registry one-to-one mapping.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/getTimedCruisePlan

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Function details

Query the plan of timing cruise of device, a "TimedCruise" ability is required to use this function(only support single channel device now)

Input parameter note

Parameter List	Note	Parameter Type	Mandatory
token	accessToken	String	Y
deviceId	Device ID	String	Y
channels	Array of channel ID	int[]	N

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_12345678901234567890123456789012",
 "deviceId":"TESTQWERXXXX-dfXXX-XX",
 "channels":[0]
 }
}

Return data field description

Field name	Field type	Field description
channels	Array	Per-channel timed cruise plans
channels[].channelId	Integer	Channel number
channels[].cruiseName	String	Cruise plan name (when returned by device)
channels[].cruises	Array	Cruise time windows and collection points

Sample output

{
 "id":"123456",
 "result":{
 "code":"0",
 "msg":"Operation is successful.",
 "data": {
 "channels": [
 {
 "channelId": 0,
 "cruiseName": "default",
 "cruises": [
 {
 "period": "everyday",
 "beginTime": "08:00:00",
 "endTime": "18:00:00",
 "collectionIndex": 1
 }
 ]
 }
 ]
 }
 }
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.