文档首页/ 行业视频管理服务 IVM/ API参考/ 目标库接口/ 目标批量添加
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

目标批量添加

功能介绍

目标批量添加，仅支持好望协议设备，使用该接口需要设备安装了目标算法，NVR800需要切换到人卡模式，SDC直连需要开启目标库对比

URI

POST /v1/{user_id}/targets/batch-add

表1 路径参数

参数

是否必选

参数类型

描述

user_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

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

参数

是否必选

参数类型

描述

device_id

是

String

设备ID：

好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

group_id

是

Integer

目标库分组ID：非负值，从获取目标库分组接口获取，NVR默认陌生人分组不可以添加目标

targets

是

Array of AddTargetsDto objects

目标数据列表：

NVR800和IVS1800：9.1以上版本支持该接口，支持批量添加，最多支持添加20个目标，NVR800的所有图片合计最大为700K，像素大小在1200*1200以内，NVR800在脱敏库中目标无法进行修改

SDC：仅支持单目标添加

storage

否

Boolean

是否保存图片：false-不保存图片，true-保存图片，默认值true，NVR800的不保存图片就会保存到脱敏名单库中，SDC和NVR800修改时改字段不生效
表4 AddTargetsDto

参数

是否必选

参数类型

描述

name

是

String

姓名：支持中英文、数字、特殊字符（_-空格），长度范围[1,128]

gender

是

String

性别：枚举类型

枚举值：

  • male 男性

  • female 女性

age

否

Integer

年龄：取值范围[1,255]（仅NVR800支持）

country

否

String

国家：支持大小写字母数字，长度范围[1,128]（SDC不支持）

nation

否

String

民族：支持大小写字母数字，长度范围[1,32]（暂不支持）

native

否

String

籍贯：支持大小写字母数字，长度范围[1,128]（IVS1800不支持）

occupation

否

String

职业：支持大小写字母数字，长度范围[1,128]（SDC不支持）

work_no

否

String

工号或身份证号之类：支持大小写数字，长度范围[1,64]

phone

否

String

电话：11位纯数字（仅NVR800支持）

email

否

String

邮箱：邮箱格式，***@.***（仅NVR800支持）

domicile

否

String

居住地：支持大小写字母数字，长度范围[1,256]（IVS1800不支持）

remark

否

String

备注信息：支持大小写字母数字，长度范围[1,512]（SDC不支持）

jpegBase64

是

String

目标图片：经过base64编码（单个图片建议不超过50K），像素大小在1200*1200以内，支持png、jpeg、jpg格式

external_target_id

否

String

用户传入的目标id：支持大小写英文、数字、_，长度范围[1,64]，NVR800不保存图片必须传external_target_id

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

targets

Array of TargetAdd objects

添加目标ID列表
表6 TargetAdd

参数

参数类型

描述

target_id

String

目标ID：目标标识符

name

String

目标名称

external_target_id

String

用户传入的名单库ID

jpegBase64

String

图片内容，经过base64编码

result

Result object

结果信息
表7 Result

参数

参数类型

描述

code

String

错误编码

msg

String

错误信息

请求示例

批量添加目标

POST /v1/2562572829***/targets/batch-add

{
	"device_id":"952352LWXT***",
	"group_id":2,
	"targets":[
		{
			"name":"mark",
			"gender":"male",
			"age":24,
			"country":"中国",
			"nation":"汉",
			"native":"杭州",
			"occupation":"工人",
			"work_no":"124****77",
			"phone":"15********61",
			"email":"1*********@qq.com",
			"domicile":"杭州",
                        "external_target_id":"10",
			"remark":"无",
                         "jpegBase64":"/9j/4AAQSkZJRgABAQAAAQABAAD..."}]
}

响应示例

状态码： 200

OK

{
  "targets" : [ {
    "name" : "mark",
    "result" : {
      "code" : "IVM.0",
      "msg" : "Success"
    },
    "target_id" : "2",
    "external_target_id":"10"
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

父主题： 目标库接口

相关文档