批量设置通道动检录像计划
功能介绍
批量为通道设置动检录像计划。一次最多设置100个通道。调用此接口时会开启请求体中通道对应的告警类型并关闭此通道其他不在请求中的告警类型。
URI
PUT /v1/{user_id}/devices/channels/record-alarm-plan
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_id |
是 |
String |
用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Access-Token |
是 |
String |
用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
channels |
是 |
Array of SetChannelRecordAlarmPlanReq objects |
设置通道录像计划请求体 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
device_id |
是 |
String |
设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型 |
|
channel_id |
是 |
String |
通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 |
|
stream_type |
否 |
String |
码流类型（目前定为主码流，不用传，为后续需求留用） |
|
plans |
是 |
Array of SetChannelRecordAlarmPlan objects |
录像计划：列表长度范围[1,21] |
|
all_day |
否 |
Boolean |
是否全程录像：枚举类型，默认为false，如果为true，time_sections省略（不进行校验） 枚举值：
|
|
time_sections |
否 |
Array of TimeSection objects |
通道录像计划时间段，取值范围[1,+∞)。如果all_day字段为空或为false，则字段必填 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarm_type |
是 |
String |
告警类型：枚举类型 枚举值：
|
|
advance_time |
是 |
Integer |
预录时间，取值范围[1,59] |
|
after_time |
是 |
Integer |
延录时间，取值范围[1,59]。advance_time和after_time相加要不超过60s。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
failed_num |
Integer |
失败数量 |
|
channels |
Array of ChannelResult objects |
通道结果 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
device_id |
String |
设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型 |
|
channel_id |
String |
通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 |
|
result |
Result object |
结果信息 |
请求示例
批量设置通道录像计划
PUT /v1/2562572829***/devices/channels/record-alarm-plan
{
"channels": [{
"device_id": "952352LWXT***",
"channel_id": "0",
"stream_type": 1,
"all_day": true,
"plans": [{
"alarm_type": "face_alarm",
"advance_time": 30,
"after_time": 15
},
{
"alarm_type": "motion_detection",
"advance_time": 30,
"after_time": 15
}]
},
{
"device_id": "952352LWXT***",
"channel_id": "1",
"stream_type": 1,
"all_day": true,
"plans": [{
"alarm_type": "face_alarm",
"advance_time": 30,
"after_time": 15
}]
}]
}
响应示例
状态码： 200
OK
{
"failed_num" : 0,
"channels" : [ {
"device_id" : "952352LWXT***",
"channel_id" : "0",
"result" : {
"code" : "IVM.0",
"msg" : "Success"
}
} ]
}
状态码
请参见状态码
错误码
请参见错误码
