ptz.cruise.get（获取巡航信息）

ptz.cruise.get：获取巡航信息

ptz.cruise.get · 通道级 · 权限 Config

功能详情

调用前设备须支持 TimedCruise（ptz.cruise.plan 亦可 RegularCruise），见巡航概览。查询本路通道巡航信息。无入参，inputData 为 {}。返回 cruiseModel、collection、cruises。调一次执行一次。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备需要基础配置权限。子用户绑定不需要。子账号需要 Config。通道级漏 channelId 返回 DV2007。设备和通道写在同一次请求里返回 DV2008。超时不代表未执行。

传入参数说明

参数名	参数类型	是否必填	参数说明
`token`	String	是	管理员、子用户或子账号 accessToken
`deviceId`	String	是	设备序列号
`productId`	String	否	可省略。传了且与该设备实际型号不一致 → `DV2009`
`channelId`	String	是	通道号，IPC 常见 `"0"`
`serviceId`	String	是	`ptz.cruise.get`
`inputData`	Object	条件	无入参传 `{}`

公共请求字段与签名见签名约定与公共请求负载。

样例输入

{
 "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": {}
 }
}

返回 data 字段说明

出参在 result.data.outputData。

参数名	说明	类型	必填	取值
`collection`	收藏点。最多 100 条。	`array`	否	最多 `100` 条
`collection.item.name`	巡航点名称。	`text`	否	字符串
`collection.item.stayTime`	停留时间，单位 s。	`enum`	否	`10`；`15`；`30`；`45`；`60`；`90`；`120`；`150`；`180`；`210`；`240`；`270`；`300`
`cruiseModel`	巡航模式。0 全景巡航，1 收藏点巡航。	`enum`	否	`0` 全景巡航；`1` 收藏点巡航
`cruises`	巡航时间段。最多 100 条。	`array`	否	最多 `100` 条
`cruises.item.beginTime`	开始时间。日内时刻，格式 THHmmss，如 T000000。	`text`	否	格式 `THHmmss`，如 `T000000`
`cruises.item.endTime`	截止时间。日内时刻，格式 THHmmss，如 T000000。	`text`	否	格式 `THHmmss`，如 `T000000`
`cruises.item.period`	生效星期。	`text`	否	常见为 0–127 位图字符串（如 `"127"` 表示每日）；set 宜与 get 读回格式一致

样例输出

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

错误码

错误码	错误码说明	下一步
`SN1001`	签名校验异常	按 HTTP 开发规范核对 `sign`
`TK1002`	token 无效或过期	重新获取 accessToken
`OP1002`	缺少必填参数	补必填字段
`OP1003`	参数不合法	按本页参数表核对
`OP1009`	权限不足	核对 token 与设备绑定/分享权限
`OP1013`	接口总次数超限	降低调用频率
`OP1014`	接口日限额超限	见接口调用限额
`DV1007`	设备离线	等设备上线

更多见错误码 · OP/SN/TK。

错误码	错误码说明	下一步
`DV2003`	设备未声明该能力	以 `device.capability.list` 为准
`DV2007`	`channelId` 与 scope 不符	通道级必传，设备级不传
`DV2008`	同请求混用设备级与通道级	拆分请求
`DV2009`	`productId` 与型号不一致	省略或改为实际型号
`DV2011`	无能力权限	见权限码

更多见能力错误码。

巡航