人脸识别管理

人脸库管理

创建人脸库

接口功能

TEXT

创建人脸库，每个人脸库最多添加500张人员照片。

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/face/createPersonSet

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
personSetName	String	Y	人脸库名称

请求示例

json

{
  "personSetName": "测试人脸库"
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	object	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
aiPersonSetId	int	人脸库id
aiPersonSetName	String	人脸库名称

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "aiPersonSetId": 1259,
        "aiPersonSetName": "测试人脸库"
    }
}

查询人脸库

接口功能

TEXT

查询人脸库信息。

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/face/queryPersonSet

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
personSetNameKeyWord	String	否	人脸库名称关键字
page	Integer	否	分页大小	默认1
pageSize	Integer	否	分页序号	默认30

请求示例

json

{
    "personSetNameKeyWord": "测试",
    "page": 1,
    "pageSize": 10
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
total	Integer	记录数	分页查询时使用
page	Integer	当前页	分页查询时使用
pageSize	Integer	页大小	分页查询时使用
data	List	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义
aiPersonSetId	int	人脸库id
aiPersonSetName	String	人脸库名称
personTotalCount	int	人脸库人员数
personMaxCount	int	人脸库人员数最大值

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "data": [{
        "aiPersonSetId": 1239,
        "aiPersonSetName": "测试人脸库",
        "personTotalCount": 6,
        "personMaxCount": 500
    }]
}

编辑人脸库

接口功能

TEXT

修改人脸库信息。

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/face/updatePersonSet

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonSetId	int	Y	人脸库id
personSetName	String	Y	人脸库新名称

请求示例

json

{
    "aiPersonSetId": 24,
    "personSetName": "监控名单1653"
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

删除人脸库

接口功能

TEXT

删除人脸库

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/face/delPersonSet

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonSetId	int	Y	人脸库id

请求示例

json

{
    "aiPersonSetId": 24
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

人员管理

上传人脸图片

接口功能

TEXT

上传人脸图片，用于人员新增。

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/person/upload/picture

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
picture	String	Y	图片base64字符串	无data:image/png;base64类似前缀
pictureName	String	Y	图片文件名称	例xxx.jpg 需携带后缀名，以供接口验证

请求示例

json

{
 "picture": "xxxx",
 "pictureName":"xx.jpg"
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	object	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
pictureUrl	string	图片url
pictureObjectId	string	图片objectId

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "pictureUrl": "https:xxxx.com/xxcasdasdasdax.jpg",
        "pictureObjectId": "19228"
    }
}

人员新增

接口功能

TEXT

人员新增

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/person/create

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonSetId	int	Y	监控名单ID
personPictures	List<String>	Y	上传用户图片	最多3张，此为objectId集合
cellphone	String	Y	电话号码
realName	String	Y	名字
sex	int	Y	性别	0:女 1:男
certificateType	int	N	证件类型	0:身份证,1:护照,2:学生证,3:警官证,4:驾驶证
identityCard	string	N	证件号码
birthday	date	N	出生日期	yyyy-MM-dd HH:mm:ss
nation	string	N	国籍
nationality	string	N	民族
occupation	string	N	职业

请求示例

json

{
    "aiPersonSetId": 25,
    "cellphone": "12413121212",
    "realName": "张三",
    "personPictures": ["12131"],
    "sex": 1
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	object	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
aiPersonId	int	监控人员id

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "aiPersonId": "123131"
    }
}

人员信息修改

接口功能

TEXT

人员信息修改

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/person/update

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonId	int	Y	监控人员ID
aiPersonSetId	int	Y	监控名单ID
personPictures	List<String>	Y	上传用户图片	最多3张，此为objectId集合
cellphone	String	Y	电话号码
realName	String	Y	名字
sex	int	Y	性别	0:女 1:男
certificateType	int	N	证件类型	0:身份证,1:护照,2:学生证,3:警官证,4:驾驶证
identityCard	string	N	证件号码
birthday	date	N	出生日期	yyyy-MM-dd HH:mm:ss
nation	string	N	国籍
nationality	string	N	民族
occupation	string	N	职业

请求示例

json

{
    "aiPersonId": 26,
    "aiPersonSetId": 25,
    "cellphone": "12413121212",
    "realName": "张三",
    "personPictures": ["12131"],
    "sex": 1
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

删除人员

接口功能

TEXT

删除人员

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/person/delete

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonId	int	Y	监控人员ID

请求示例

json

{
    "aiPersonId": 26
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

人员查询

接口功能

TEXT

人员查询

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/person/list

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonSetId	int	Y	监控名单ID
queryKey	string	N	搜索关键字，姓名、手机号
sex	int	N	0:女 1:男
page	int	N	分页参数-页数	默认1
pageSize	int	N	分页参数-每页条数	默认30

请求示例

json

{
    "aiPersonSetId": 26,
    "queryKey": "xxxx",
    "sex": 1,
    "page": 1,
    "pageSize": 30
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
total	Integer	记录数	分页查询时使用
page	Integer	当前页	分页查询时使用
pageSize	Integer	页大小	分页查询时使用
data	List	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
aiPersonId	int	监控人员id
cellphone	string	电话号码
realName	string	名字
sex	int	性别	0:女 1:男
certificateType	int	证件类型	0:身份证,1:护照,2:学生证,3:警官证,4:驾驶证
identityCard	string	证件号码
age	int	年龄
birthday	date	出生日期	yyy-MM-dd HH:mm:ss
nation	string	国籍
nationality	string	民族
occupation	string	职业
personPictureVos	PersonPictureVo[]	人员图片集合	至少一个

PersonPictureVo

参数名称	参数类型	参数含义
aiPersonPictureId	int	图片ID
pictureUrl	string	下载地址
frontCover	boolean	是否是封面图
pictureObjectId	string	图片objId

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "total": 1,
    "page": 1,
    "pageSize": 30,
    "data": [{
        "aiPersonId": 63767,
        "realName": "熊远婷3修改",
        "sex": 1,
        "cellphone": "18243821392",
        "birthday": "1992-03-03 00:00:00",
        "age": 31,
        "certificateType": 4,
        "identityCard": "500109192202026321",
        "nation": "中国",
        "nationality": "土家族",
        "occupation": "渔民",
        "personPictureVos": [{
                "aiPersonPictureId": 65575,
                "pictureUrl": "https://xxxxxx",
                "pictureObjectId": "yywsai-test/person-picture/6312a38445a94becb0815bcb34a41748.jpg",
                "frontCover": true
            },
            {
                "aiPersonPictureId": 65577,
                "pictureUrl": "https://xxxxxxx",
                "pictureObjectId": "yywsai-test/person-picture/6312a38445a94becb0815bcb34a41748.jpg",
                "frontCover": false
            },
            {
                "aiPersonPictureId": 65579,
                "pictureUrl": "https://xxxxxxx",
                "pictureObjectId": "yywsai-test/person-picture/6312a38445a94becb0815bcb34a41748.jpg",
                "frontCover": false
            }
        ]
    }]
}

布控管理

添加布控任务

接口功能

TEXT

添加布控任务

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/monitor/task/add

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
taskName	String	Y	布控任务名称
aiPersonSetIds	int[]	Y	监控名单id（多id）	布控对象，监控名单id（可多选限制100)
startTime	string	Y	开始时间	yyy-MM-dd HH:mm:ss
endTime	String	Y	结束时间	yyy-MM-dd HH:mm:ss
taskDescription	String	N	任务描述	最多120位
deviceIdList	string[]	N	设备ID集合	设备ID集合必传,限制100
threshold	int	N	布控阈值	传值范围45-100，不传默认设置为45

请求示例

json

{
    "taskName": "123",
    "aiPersonSetIds": [79, 80],
    "startTime": "2020-11-25 00:00:00",
    "endTime": "2020-11-26 00:00:00",
    "taskDescription": "adsad",
    "deviceIdList": ["10123456789123456789"]
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	object	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
monitorTaskId	int	布控任务id

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "monitorTaskId": 123
    }
}

编辑布控任务

接口功能

TEXT

编辑布控任务

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/monitor/task/edit

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
monitorTaskId	int	Y	布控任务id
taskName	String	Y	布控任务名称	不修改时，原值也需传入
aiPersonSetIds	int[]	Y	监控名单id（多id）	布控对象，监控名单id（可多选限制100) ；不修改时，原值也需传入
startTime	string	Y	开始时间	yyy-MM-dd HH:mm:ss，不修改时，原值也需传入
endTime	String	Y	结束时间	yyy-MM-dd HH:mm:ss，不修改时，原值也需传入
taskDescription	String	N	任务描述	最多120位
deviceIdList	string[]	Y	设备ID集合	设备ID集合必传,限制100，不修改时，原值也需传入
threshold	int	Y	布控阈值	传值范围45-100，不修改时，原值也需传入

请求示例

json

{
    "monitorTaskId":1,
    "taskName": "123",
    "aiPersonSetIds": [79, 80],
    "startTime": "2020-11-25 00:00:00",
    "endTime": "2020-11-26 00:00:00",
    "taskDescription": "adsad",
    "deviceIdList": ["10123456789123456789"]
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

删除布控任务

接口功能

TEXT

删除布控任务

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/monitor/task/delete

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
monitorTaskId	int	Y	布控任务id

请求示例

json

{
    "monitorTaskId":1
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功"
}

查询布控任务

接口功能

TEXT

查询布控任务

请求地址

TEXT

  https://open.qly.cmviot.cn/v3/open/api/ai/monitor/task/query

请求方式

TEXT

  POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
aiPersonSetIds	int[]	N	人脸库id（多id）限制100	注意：多监控名单id 取“或”关系例: 布控任务1（aiPersonSetId:3，5）布控任务2（aiPersonSetId:3，4）当我入参传的 3,5时能把布控任务1，2 查出来
monitorTaskType	int	N	布控任务类型	1:黑名单 2:白名单
status	string	N	布控任务状态	0:暂停 1:开启
queryKey	string	N	布控任务名称	支持模糊查询
page	int	N	分页参数-页数	默认1
pageSize	int	N	分页参数-每页条数	默认30

请求示例

json

{
    "queryKey": "xxx",
    "monitorTaskType": 1,
    "aiPersonSetIds": [
        144,
        145
    ],
    "status": 1,
    "pageSize": 10,
    "page": 1
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
total	Integer	记录数	分页查询时使用
page	Integer	当前页	分页查询时使用
pageSize	Integer	页大小	分页查询时使用
data	List	响应数据	响应数据

data数据模型

参数名称	参数类型	参数含义	说明
monitorTaskId	int	布控任务id
taskName	string	布控任务名称
taskDescription	string	任务描述
startTime	string	开始时间
endTime	string	结束时间
status	int	状态	0:暂停 1:开启
monitorTaskType	int	布控任务类型	1:黑名单 2:白名单
deviceIdList	string[]	设备ID集合
aiPersonSetIdList	int[]	人脸库id集合

返回数据示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "total": 100,
    "page": 1,
    "pageSize": 2,
    "data": [{
        "monitorTaskId": 1,
        "taskName": "123",
        "aiPersonSetIds": [79, 80],
        "startTime": "2020-11-25 00:00:00",
        "endTime": "2020-11-26 00:00:00",
        "taskDescription": "adsad",
        "deviceIdList": ["10123456789123456789"]
    }]
}

人脸识别管理 ​

人脸库管理 ​

创建人脸库 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

查询人脸库 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

编辑人脸库 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

删除人脸库 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

人员管理 ​

上传人脸图片 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

人员新增 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

人员信息修改 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

删除人员 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

人员查询 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

返回数据示例 ​

布控管理 ​

添加布控任务 ​

接口功能 ​

请求地址 ​

请求方式 ​

人脸识别管理

人脸库管理

创建人脸库

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

查询人脸库

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

编辑人脸库

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

删除人脸库

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

人员管理

上传人脸图片

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

人员新增

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

人员信息修改

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

删除人员

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

人员查询

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

返回数据示例

布控管理

添加布控任务

接口功能

请求地址

请求方式