人脸识别

添加人脸

更新时间: 2025/03/05 16:07:31

接口说明

向人脸库中添加人脸,若人脸图片中包含多张人脸则取最大人脸添加。

接口URL

https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/user/add

请求方式:POST

请求参数

Header

名称 参数值 是否必传 说明
Content-Type multipart/form-data 是 请求头

Body

公共参数

接口参数

参数名称 类型 是否必传 说明
GroupId String 是 用户组id,标识一组用户(由数字、字母、下划线组成)
PersonId String 是 用户id,标识一个用户(由数字、字母、下划线组成)
Image File 是 人脸图片,人脸必须是正面无遮挡人脸,大小不可超过5M,分辨率小于4000*2000,支持 PNG、JPG、JPEG 格式;
注:组内每个用户的人脸总数量不可超过5张。
PersonInfo String 否 用户信息,支持字母、数字、标点符号和汉字,不超过200个字符;
默认空。
ActionType String 否 操作方式
APPEND:当 PersonId 已存在时,新注册的图片将追加到该 PersonId 下的现有图片列表中。
REPLACE:当 PersonId 重复注册时,新图片将替换该 PersonId 下的所有现有图片。
默认使用 APPEND

返回参数

名称 类型 说明
RspCode Integer 错误码
RspDesc String 描述
Data Map 数据集合

Data参数说明:

名称 类型 说明
FaceId String 人脸图片id
- Location Object 人脸在图片中的位置
- Left Double 人脸区域离左边界的距离
- Top Double 人脸区域离上边界的距离
- Width Double 人脸区域的宽度
- Height Double 人脸区域的高度

示例

请求示例

curl -X POST https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/user/add \
-H "Content-Type: multipart/form-data" \
-F "RequestId=2d95a5fe-a384-5dea-0d84-db153b10ee0f"  \
-F "AppId=demo"  \
-F "CompID=1"  \
-F "SecretKey=a7febff6a21c36fb50150f88c95ef641"  \
-F "GroupId=test_group_1" \
-F "PersonId=1001" \
-F "PersonInfo=test1" \
-F "ActionType=APPEND" \
-F "Image=@face.jpg"

返回示例

{
    "RspCode":0,
    "RspDesc":"请求成功",
    "Data":{
        "FaceId":"face37d71456a89e35ff0dd",
        "Location":{
            "Left":1051.66,
            "Top":850.38,
            "Width":627,
            "Height":605
        }
    }
}

错误码

上述接口在 Body 中返回请求的错误码,详情请参见 错误码