setCruiseConfig（设置定时巡航）

新接入请优先使用设备能力与事件与 V2 设备 API。本页保留给仍在调用 POST /openapi/setTimeCruisePlan 的兼容对接。

setCruiseConfig：设置定时巡航

要点：https://openapi.lechange.cn/openapi/setCruiseConfig · 权限 "Permission":"Config" "Resource":"cam:序列号:通道号" · 见错误码

设置设备的定时巡航配置。

请求参数

参数名			参数类型	是否必填	合法值	参数说明
token			String	是		管理员或者子账号accessToken
deviceId			String	是		设备序列号
channelId			String	是		通道号
cruisePlan	cruiseName		String	否		巡航计划唯一标示符
	mode		String	是	default：默认模式，即全景巡航; collection：定制模式，即收藏点巡航	巡航模式
	cruisePath		String	否	当mode=collection时必填，可选值如下：default：默认路径，由设备端决定；custom：自定义路径，即collection中收藏点的顺序	巡航路径
	collection	name	String	否	当mode为collection，cruisePath为custom时必填	收藏点名
	collection	stayTime	Integer	否	当mode为collection，cruisePath为custom时必填	停留时间（s）
	cruises	period	String	是	Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday 只可设置一天，若需设置多天请设置多个巡航周期和起止时间	巡航周期
		beginTime	String	是	时间格式为：THHMMSS	开始时间
		endTime	String	是	时间格式为：THHMMSS	结束时间

注意：collection字段必须存在且为列表，其内容根据下面取值不同，限制不同： 1. 当mode为default时，cruisePath可选，collection字段长度和内容不限制; 2. 当mode为collection时，cruisePath必须存在，且为default或者custom之一； 2.1 如果cruisePath是default，collection字段内容和数组长度不限； 2.2 如果cruisePath为custom，collection字段长度不能为0，内容必须符合协议，且所设置收藏点name必须是加入巡航计划中的收藏点（即调用setCollection接口的needCruise字段为true），否则将不生效。 3. getCruiseConfig 读回的 cruisePath 值为 collection 时，与写入 custom 对应。

请求示例

{
    "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":"TESTQWERXXXX",
        "channelId":"0",
        "cruisePlan": {
            "cruiseName":"cruiseName",
            "mode":"collection",
            "cruisePath":"custom",
            "collection":[{
                "name":"collectionName",
                "stayTime":15
            }],
            "cruises":[{
                "period":"Tuesday",
                "beginTime":"T023122",
                "endTime":"T112233"
            }]
        }
    }
}

响应字段

无data数据返回

响应示例

{
    "result":{
        "msg":"操作成功。",
        "code":"0"
    },
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}

错误码

本接口可能返回下列码；完整分组见错误码。

网关与鉴权（SN / TK / OP）

错误码	错误码说明	下一步
`SN1001`	签名异常	按签名核对 `sign`
`TK1002`	token 无效或过期	重新获取 token
`OP1002`	缺少必填参数	补必填字段
`OP1003`	参数不合法	按本页参数表核对
`OP1039`	分钟级限流	等到下一分钟再试
`OP1040`	调用超限	降低频率
`DV1007`	设备离线或超时	等设备上线

子账号（SUB）

错误码	错误码说明	下一步
`SUB1001`	子账号无指定权限	在子账号策略中补权限
`SUB1002`	子账号无任何设备权限	授权设备或调整策略
`SUB1005`	子账号 token 过期	重新获取子账号 token
`SUB1006`	子账号与设备无授权关系	核对 `Resource` 与设备序列号
`SUB1008`	子账号未绑定当前应用	先创建并绑定子账号
`SUB1007`	创建子账号失败	核对参数后重试
`SUB1009`	子账号创建失败，账号格式错误	`account` 须为手机号或邮箱
`SUB1010`	子账号创建失败，账号已存在	勿重复绑定同一子账号到应用

更多见错误码 · SUB。

设备访问与通道（DV10xx）

错误码	错误码说明	下一步
`DV1007`	设备离线或超时	等设备上线；低电休眠先唤醒
`DV1009`	设备正忙	稍后重试
`DV1012`	分享/授权设备权限不足	核对子账号 `Permission` / `Resource`
`DV1019`	能力集不支持	确认型号与设备能力
`DV1020`	通道离线	检查通道与设备状态
`DV1026`	不支持此功能	换接口或升级固件
`DV1028`	未绑定或通道不存在	核对 `deviceId` / `channelId`
`DV1030`	设备休眠	唤醒后再调
`DV1057`	通道不存在	核对通道号
`DV1061`	设备响应超时	检查设备网络
`DV1062`	需先唤醒设备	调用唤醒接口
`DV1069`	不满足操作条件	见 `msg`

说明

子账号 token 须具备最小权限：Permission 为 Config，Resource 为 cam:{deviceId}:{channelId}。配置见权限码。

与 V2 能力 invoke 对照（新接入优先 invoke + device.capability.list 发现）：

legacy（本页 `cruisePlan`）	V2 `ptz.cruise.set` · `inputData`
`mode`：`default` / `collection`	`cruiseModel`：`0` 全景 / `1` 收藏点
`cruises[].period`：英文星期如 `Tuesday`	`period`：逗号分隔多日，如 `1,2,3,4,5`
嵌套 `cruisePlan` 对象	扁平 `inputData` 字段

详见设置巡航信息、获取巡航信息。