一、接口描述
接口说明:
·音频要求同 VoiceprintEnroll(RegisterTRTCVoicePrint):16kHz/16bit/单声道 PCM 或 WAV;Base64 解码后 ≤ 2MB;PCM 裸数据 10s ≤ 时长 ≤ 45s。
·阈值判决完全由服务端裁定(默认 60 分),Score 为字符串保留两位小数,Decision 为 0/1。
·不消费声纹配额、不改动底库,仅做比对。
注意:说明:
注意:默认接口请求频率限制:20次/秒。
二、输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:VerifyTRTCVoicePrint。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| VoicePrintId | 是 | String | 待验证的目标声纹 ID(由 RegisterTRTCVoicePrint 返回)。按 (AppId, SdkAppId, VoicePrintId) 做数据隔离。示例值:19dbb72269b_1e7b262ef347400490f19956bc293016 |
| Data | 是 | String | 待验证音频数据的 Base64 字符串。要求:16kHz/16bit/单声道 PCM 或 WAV;Base64 解码后 ≤ 2MB;PCM 裸数据 10s ≤ 时长 ≤ 45s。示例值:base64_encoded_audio_data |
| SdkAppId | 是 | String | SdkAppId。示例值:1400123456 |
| AudioFormat | 否 | String | 音频格式,可选 pcm 或 wav,大小写不敏感,不传默认为 pcm。示例值:pcm |
三、输出参数
| 参数名称 | 类型 | 描述 |
| VoicePrintId | String | 被验证的目标声纹 ID。示例值:19dbb72269b_1e7b262ef347400490f19956bc293016 |
| SpeakerId | String | 注册时写入的业务方 SpeakerId(以服务端记录为准)。示例值:user1 |
| Score | String | 相似度分值(字符串形式,保留两位小数,范围约 0 – 100,越大越相似)。示例值:100.00 |
| Decision | Integer | 服务端阈值判决结果,0=不通过,1=通过(默认阈值 60 分,由服务端统一维护)。示例值:1 |
| Message | String | 结果描述,成功时为 voiceprint verify success。示例值:voiceprint verify success |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1Host: trtc.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: VerifyTRTCVoicePrint<公共请求参数>{ "VoicePrintId": "19dbb72269b_1e7b262ef347400490f19956bc293016", "Data": "base64_encoded_audio_data", "SdkAppId": "1400123456", "AudioFormat": "pcm"}
五、输出示例
{ "Response": { "Decision": 1, "Message": "voiceprint verify success", "RequestId": "6dd6414b-3695-4db7-af24-7f1a3ef41d0c", "Score": "100.00", "SpeakerId": "user1", "VoicePrintId": "19dbb72269b_1e7b262ef347400490f19956bc293016" }}
六、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
七、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
八、SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
九、命令行工具
·Tencent Cloud CLI 3.0
十、错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| AuthFailure.UnRealNameAuthenticated | 未完成实名认证,不允许此操作。 |
| AuthFailure.UnauthorizedOperation | CAM 鉴权失败。 |
| FailedOperation.VoicePrintNotFound | 声纹不存在或已被删除。 |
| InternalError.FailAccessDatabase | 访问数据库失败。 |
| InternalError.InternalError | 内部错误,请重试。 |
| InvalidParameter.AudioFormat | 音频格式非法(仅支持 pcm/wav)或 Base64 解码失败。 |
| InvalidParameter.AudioTooLarge | 音频数据大小超过 2MB。 |
| InvalidParameter.AudioTooLong | 音频时长超过 45 秒。 |
| InvalidParameter.AudioTooShort | 音频有效时长不足 10 秒。 |
| InvalidParameterValue.ErrorInvalidAppid | AppId 无效。 |
| InvalidParameterValue.InvalidSdkAppId | 无效的 SdkAppId。 |
| InvalidParameterValue.InvalidVoicePrintId | 无效的 VoicePrintId(为空、格式非法)。 |