人脸管理接口

更新时间：2019-07-04

人脸创建接口

接口描述

在指定的人脸库下创建人脸，如果指定的人脸库ID有多个，则会在指定的人脸库下都创建人脸。

权限说明

请求发起人需要具有合法的根据token接口获取到的token才能发起请求。

请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/face/create
Header如下：

头域	类型	说明	是否必须
Authorization	String	填写根据token接口获取到的token	必须

请求参数 Body中放置请求参数，参数详情如下：

名称	类型	描述	是否必须
groupIds	List	人脸库ID，需提前创建，指定当前人脸要绑定的人脸库	必须
uid	String	不可修改，支持英文、数字、下划线，长度不超过32个字符。用户自定义。	必须
name	String	支持中文、英文、空格，长度不超过20个字符，并且必须要有一个非空字符	必须
title	String	称谓，可以为空，长度不超过20个字符	非必须
image	String	图片base64数据，需要注意的是，图片的base64编码是不包含图片头的，如data:image/jpg;base64。若一张图片中包含多张人脸，只选取其中人脸面积最大的人脸。支持PNG、JPG、JPEG、BMP格式。图片大小不超过2M。	必须
gender	String	性别，如果填写，则必须是male或female	非必须
remark	String	备注信息，长度不超过100字符	非必须

返回头域 除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
error_code	int	错误码
error_msg	String	错误提示信息
result	Object	操作结果展示Model

result的数据类型如下：

参数名称	类型	描述
uid	String	人脸id
name	String	姓名
title	String	称谓
groups	List	当前人脸关联的人脸库ID
image	String	图片base64数据
gender	String	性别
remark	String	备注
createTime	long	创建时间
updateTime	long	更新时间

请求示例

POST HTTP/1.1
 Host: robot.baidu.com
 Content-Type: application/json;charset=UTF-8
 Authorization: authorization string
 {
     "uid":"face_uid",
     "name":"user name",
     "title":"title from customer",
     "groupIds":[
         "customerGroupId1",
         "customerGroupId2"
     ],
     "image":"base64 encoded image",
     "gender":"female",
     "remark":"remark"
 }

响应示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 {
     "error_code":0,
     "error_msg":"操作成功",
     "result": {
         "uid":"face_uid",
         "name":"user name",
         "title":"title from customer",
         "groups":["customerGroupId1","customerGroupId2"],
         "image":"base64 encoded image",
         "gender":"gender from customer",
         "remark":"remark",
         "createTime":1547119839635,
         "updateTime":1547119839635
         }
 }

人脸修改接口

接口描述

修改指定的人脸信息。

权限说明

请求发起人需要具有合法的根据token接口获取到的token才能发起请求。

请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/face/update
Header如下：

头域	类型	说明	是否必须
Authorization	String	填写根据token接口获取到的token	必须

请求参数 Body中放置请求参数，参数详情如下：

名称	类型	描述	是否必须
uid	String	人脸ID	必须
name	String	支持中文、英文、空格，长度不超过20个字符，并且必须要有一个非空字符	非必须
title	String	称谓，可以为空，长度不超过20个字符	非必须
image	String	图片base64数据，需要注意的是，图片的base64编码是不包含图片头的，如data:image/jpg;base64。若一张图片中包含多张人脸，只选取其中人脸面积最大的人脸。支持PNG、JPG、JPEG、BMP格式。图片大小不超过2M。	非必须
gender	String	性别，如果填写，则必须是male或female	非必须
remark	String	备注	非必须

返回头域 除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
error_code	int	错误码
error_msg	String	错误提示信息

请求示例

POST HTTP/1.1
 Host: robot.baidu.com
 Content-Type: application/json;charset=UTF-8
 Authorization: authorization string
 {
     "uid":"face_uid",
     "name":"user name",
     "title":"title from customer",
     "image":"base64 encoded image",
     "gender":"female",
     "remark":"remark"
 }

响应示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 {
     "error_code":0,
     "error_msg":"操作成功"
 }

人脸详情接口

接口描述

获取指定的人脸详情信息

权限说明

请求发起人需要具有合法的根据token接口获取到的token才能发起请求。

请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/face/detail
Header如下：

头域	类型	说明	是否必须
Authorization	String	填写根据token接口获取到的token	必须

请求参数 Body中放置请求参数，参数详情如下：

名称	类型	描述	是否必须
uid	String	人脸ID	必须

返回头域 除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
error_code	int	错误码
error_msg	String	错误提示信息
result	Object	操作结果展示Model

result的数据类型如下：

参数名称	类型	描述
uid	String	人脸id
name	String	姓名
title	String	称谓
groups	List	当前人脸关联的人脸库ID
image	String	图片base64数据
gender	String	性别
remark	String	备注
createTime	long	创建时间
updateTime	long	更新时间

请求示例

POST HTTP/1.1
 Host: robot.baidu.com
 Content-Type: application/json;charset=UTF-8
 Authorization: authorization string
 {
     "uid":"face_uid"
 }

响应示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 {
     "error_code":0,
     "error_msg":"操作成功",
     "result": {
         "uid":"group1_uid",
         "name":"user name",
         "title":"title from customer",
         "groups":["customerGroupId1","customerGroupId2"],
         "image":"base64 encoded image",
         "gender":gender from customer,
         "remark":"remark",
         "createTime":1547119839635,
         "updateTime":1547119839635
         }
 }

人脸删除接口

接口描述

删除一个指定的人脸，您可以选择在一个指定的人脸库中删除该人脸，或者在所有的人脸库删除该人脸。

权限说明

请求发起人需要具有合法的根据token接口获取到的token才能发起请求。

请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/face/delete
Header如下：

头域	类型	说明	是否必须
Authorization	String	填写根据token接口获取到的token	必须

请求参数 Body中放置请求参数，参数详情如下：

名称	类型	描述	是否必须
uid	String	人脸ID	必须
groupIds	List	如果groupIds不为空，则在指定的人脸库中删除该人脸；如果为空，则在所有的人脸库删除该人脸。	非必须

返回头域 除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
error_code	int	错误码
error_msg	String	错误提示信息

请求示例

POST HTTP/1.1
 Host: robot.baidu.com
 Content-Type: application/json;charset=UTF-8
 Authorization: authorization string
 {
     "uid":"face_uid",
     "groupIds":["customerGroupId1","customerGroupId2"]
 }

响应示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 {
     "error_code":0,
     "error_msg":"操作成功"
 }

人脸库间复制接口

接口描述

将用户人脸信息在人脸库间复制，以允许在另一个人脸库下也能识别出当前用户。

权限说明

请求发起人需要具有合法的根据token接口获取到的token才能发起请求。

请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/face/copy
Header如下：

头域	类型	说明	是否必须
Authorization	String	填写根据token接口获取到的token	必须

请求参数 Body中放置请求参数，参数详情如下：

名称	类型	描述	是否必须
uid	String	人脸ID	必须
groupIds	List	需要复制人脸用户的人脸库ID	必须

返回头域 除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
error_code	int	错误码
error_msg	String	错误提示信息

请求示例

POST HTTP/1.1
 Host: robot.baidu.com
 Content-Type: application/json;charset=UTF-8
 Authorization: authorization string
 {
     "uid":"face_uid",
     "groupIds":["customerGroupId1","customerGroupId2"]
 }

响应示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 {
     "error_code":0,
     "error_msg":"操作成功"
 }

人脸列表查询接口

接口描述

查询指定人脸库下的人脸列表。

权限说明

请求发起人需要具有合法的根据token接口获取到的token才能发起请求。

请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/face/query
Header如下：

头域	类型	说明	是否必须
Authorization	String	填写根据token接口获取到的token	必须

请求参数 Body中放置请求参数，参数详情如下：

名称	类型	描述	是否必须
groupId	String	人脸库ID	必须
pageNo	int	查询页数，大小不能小于1	必须
pageSize	int	每页显示数量，范围为1-100	必须

返回头域 除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
error_code	int	错误码
error_msg	String	提示信息
result	Object	操作结果展示Model

result的数据类型如下：

参数名称	类型	描述
pageSize	int	每页显示数量
curPage	int	当前页
totalPage	long	总页数
totalNumber	long	总条数
content	Array	列表内容

content的数据类型如下：

参数名称	类型	描述
uid	String	人脸ID
name	String	姓名
gender	String	性别
title	String	称谓
registerDate	String	更新时间
remark	String	备注

请求示例

POST HTTP/1.1
 Host: robot.baidu.com
 Content-Type: application/json;charset=UTF-8
 Authorization: authorization string
 {
     "groupId":"Default"
     "pageNo":1
     "pageSize":15
 }

响应示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 {
     "error_code":0,
     "error_msg":"操作成功",
     "result": {
         "pageSize":15,
         "curPage":1,
         "totalPage":1,
         "totalNumber":1,
         "content":[
            {
                "uid":"001",
                "name":"zhangsan",
                "gender":"male",
                "title":"title of user",
                "registerDate":"2019-05-30 18:59:06",
                "remark":"register remark"
            }
         ]
     }
 }

人脸库管理接口

错误码

百度智能云

机器人开放平台

机器人开放平台

人脸管理接口

人脸创建接口

人脸修改接口

人脸详情接口

人脸删除接口

人脸库间复制接口

人脸列表查询接口