文档首页/ 行业视频管理服务 IVM/ API参考/ 录像配置管理/ 批量设置通道动检录像计划
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

批量设置通道动检录像计划

功能介绍

批量为通道设置动检录像计划。一次最多设置100个通道。调用此接口时会开启请求体中通道对应的告警类型并关闭此通道其他不在请求中的告警类型。

URI

PUT /v1/{user_id}/devices/channels/record-alarm-plan

表1 路径参数

参数

是否必选

参数类型

描述

user_id

是

String

用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取
表3 请求Body参数

参数

是否必选

参数类型

描述

channels

是

Array of SetChannelRecordAlarmPlanReq objects

设置通道录像计划请求体
表4 SetChannelRecordAlarmPlanReq

参数

是否必选

参数类型

描述

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省略（不进行校验）

枚举值：

  • true 是
  • false 否

time_sections

否

Array of TimeSection objects

通道录像计划时间段，取值范围[1,+∞)。如果all_day字段为空或为false，则字段必填
表5 SetChannelRecordAlarmPlan

参数

是否必选

参数类型

描述

alarm_type

是

String

告警类型：枚举类型

枚举值：

  • motion_detection 移动侦测报警
  • io_event 外部IO输入报警
  • target_alarm 目标报警
  • mask_alarm 口罩报警
  • people_queue_alarm 排队长度报警
  • people_count_region_alarm 区域人数统计报警
  • people_count_line_alarm 过线人数统计报警
  • over_line_alarm 越线检测报警
  • region_invasion_alarm 区域入侵报警
  • region_in_alarm 区域进入报警
  • region_out_alarm 区域离开报警
  • fast_move_alarm 快速移动报警
  • linger_alarm 徘徊检测报警
  • thirdparty_intelligent 第三方告警
  • face_alarm 人脸告警
  • abandon_alarm 物品遗留告警
  • removed_alarm 物品移走告警
  • electric_bicycle_alarm 电瓶车检测告警
  • people_leave_station_alarm 人员离岗告警
  • lift_electric_alarm 电梯电瓶车告警_新
  • occlusion_alarm 遮挡告警

advance_time

是

Integer

预录时间，取值范围[1,59]

after_time

是

Integer

延录时间，取值范围[1,59]。advance_time和after_time相加要不超过60s。
表6 TimeSection

参数

是否必选

参数类型

描述

day_of_week

是

Integer

日期：取值范围[1,7]（对应周一~周日）

start_time

是

String

录像开始时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59]

end_time

是

String

录像结束时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59]

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

failed_num

Integer

失败数量

channels

Array of ChannelResult objects

通道结果
表8 ChannelResult

参数

参数类型

描述

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

结果信息
表9 Result

参数

参数类型

描述

code

String

错误编码

msg

String

错误信息

请求示例

批量设置通道录像计划

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"
    }
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

父主题： 录像配置管理

相关文档