有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: facefusion.tencentcloudapi.com 。

本接口用于人脸融合,用户上传人脸图片,获取与模板融合后的人脸图片。未发布的活动请求频率限制为1次/秒,已发布的活动请求频率限制50次/秒。如有需要提高活动的请求频率限制,请在控制台中申请。

  • 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:FaceFusion。
Version String 公共参数,本接口取值:2018-12-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-nanjing, ap-shanghai 。
ProjectId String 活动 ID,请在人脸融合控制台查看。
示例值:100646
ModelId String 素材 ID,请在人脸融合控制台查看。
示例值:qc_100646_154021_9
RspImgType String 返回图像方式(url 或 base64) ,二选一。url有效期为7天。
示例值:url
Image String 图片 base64 数据。请确保人脸为正脸,无旋转。若某些手机拍摄后人脸被旋转,请使用图片的 EXIF 信息对图片进行旋转处理;请勿在 base64 数据中包含头部,如“data:image/jpeg;base64,”。
示例值:image_base64
PornDetect Integer 历史遗留字段,无需填写。因为融合只需提取人脸特征,不需要鉴黄。
示例值:10
CelebrityIdentify Integer 0表示不需要不适宜内容识别,1表示需要不适宜内容识别。默认值为0。
请注意,不适宜内容识别服务开启后,您需要根据返回结果自行判断是否调整您的业务逻辑。例如提示您的用户图片非法,请更换图片。
示例值:0
Url String 图片Url地址
示例值:image_url
FuseParam FuseParam 融合参数

3. 输出参数

参数名称 类型 描述
Image String RspImgType 为 url 时,返回结果的 url, RspImgType 为 base64 时返回 base64 数据。
示例值:image_url
ReviewResultSet Array of FuseFaceReviewResult 不适宜内容识别结果
示例值:[]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用返回成功

输入示例

https://facefusion.tencentcloudapi.com/?Action=FaceFusion
&ProjectId=100646
&ModelId=qc_100646_154021_9
&RspImgType=url
&Image=base64_string
&<公共请求参数>

输出示例

{
    "Response": {
        "Image": "https://facefusion-1254418846.cos.ap-guangzhou.myqcloud.com/qc_100646_204857_1_1543312645513131155.jpg",
        "RequestId": "66676130-5588-4cdb-a81e-8bd3c99cea1f",
        "ReviewResultSet": [
            {
                "Category": "Politics",
                "Code": "0",
                "CodeDescription": "OK",
                "Suggestion": "PASS",
                "Confidence": 30,
                "DetailSet": [
                    {
                        "Field": "",
                        "Label": "丁俊晖",
                        "Confidence": 30,
                        "Suggestion": "PASS"
                    }
                ]
            }
        ]
    }
}

示例2 调用返回失败

输入示例

https://facefusion.tencentcloudapi.com/?Action=FaceFusion
&ProjectId=100646
&ModelId=qc_100646_154021_9
&RspImgType=url
&Image=base64_string
&<公共请求参数>

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.FuseDetectNoFace",
            "Message": "未检测到人脸."
        },
        "RequestId": "8ae581fd-c25f-4a63-83b3-d9fcd97230c8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.InvalidAuthorization 认证失败。
FailedOperation.FaceBorderCheckFailed 人脸配准点出框错误码。
FailedOperation.FaceExceedBorder 人脸出框,无法使用。
FailedOperation.FaceFusionError 人脸融合失败,请更换图片后重试。
FailedOperation.FaceRectInvalid 人脸框不合法。
FailedOperation.FaceShapeFailed 人脸配准失败。
FailedOperation.FaceSizeTooSmall 人脸因太小被过滤,建议人脸分辨率不小于34*34。
FailedOperation.FuseFreqCtrl 操作太频繁,触发频控。
FailedOperation.FuseImageError 图像处理出错。
FailedOperation.FuseInnerError 服务内部错误,请重试。
FailedOperation.FuseMaterialNotAuth 素材未经过审核。
FailedOperation.FuseMaterialNotExist 素材不存在。
FailedOperation.FuseSavePhotoFail 保存结果图片出错。
FailedOperation.ImageDecodeFailed 人脸检测-图片解码失败。
FailedOperation.ImageDownloadError 图片下载失败。
FailedOperation.ImagePixelExceed 素材尺寸超过1080*1080像素。
FailedOperation.ImageResolutionExceed 图片分辨率过大。建议您resize压缩到3k*3k以内。
FailedOperation.ImageResolutionTooSmall 图片短边分辨率小于64。
FailedOperation.ImageSizeExceed 输入图片base64数据大小超过5M。
FailedOperation.ImageSizeInvalid 图片尺寸过大或者过小;不满足算法要求。
FailedOperation.InnerError 服务内部错误。
FailedOperation.NoFaceDetected 无法检测出人脸, 人脸框配准分低于阈值。
FailedOperation.ParameterValueError 参数字段或者值有误。
FailedOperation.ProjectNotAuth 活动未支付授权费或已停用。
FailedOperation.RequestEntityTooLarge 请求实体太大。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.RpcFail RPC请求失败,一般为算法微服务故障。
FailedOperation.ServerError 系统内部错误。
FailedOperation.TemplateFaceIDNotExist 素材人脸ID不存在。
FailedOperation.Unknown 未知错误。
InvalidParameterValue.ActivityIdNotFound 未查找到活动id。
InvalidParameterValue.FaceRectParameterValueError 人脸框参数有误或者人脸框太小。
InvalidParameterValue.ImageEmpty 人脸检测-图片为空。
InvalidParameterValue.MaterialIdNotFound 未查找到素材Id。
InvalidParameterValue.NoFaceInPhoto 人脸检测-图片没有人脸。
InvalidParameterValue.ParameterValueError 参数字段或者值有误。
ResourceUnavailable.Delivering 资源正在发货中。
ResourceUnavailable.Freeze 账号已被冻结。
ResourceUnavailable.GetAuthInfoError 获取认证信息失败。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.LowBalance 余额不足。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.NotReady 服务未开通。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 账号已停服。
ResourceUnavailable.UnknownStatus 计费状态未知。
ResourcesSoldOut.ChargeStatusException 账号已欠费。