一、接口描述
接口说明:
·按 (AppId, SdkAppId, VoiceprintId) 做数据隔离,跨租户 ID 会被当作 VoiceprintNotFound 失败项返回。
·成功项返回 VoiceprintId,失败项返回 VoiceprintId + ErrorCode + ErrorMessage。
·已删除的声纹再次批量删除会计入 FailCount(错误码 FailedOperation.VoiceprintNotFound)。
注意:说明:
注意:默认接口请求频率限制:20次/秒。
二、输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:BatchDeleteTRTCVoicePrint。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| VoicePrintIds.N | 是 | Array of String | 待批量删除的声纹 ID 列表,最多 50 个;请求内自动去重;按 (AppId, SdkAppId, VoicePrintId) 做数据隔离。示例值:["19dbb1d12cd_9610feccb7dc4548910724f3f78a2d9d"] |
| SdkAppId | 是 | String | SdkAppId。示例值:1400123456 |
三、输出参数
| 参数名称 | 类型 | 描述 |
| SuccessCount | Integer | 成功删除的声纹数量(按数据库实际删除行数统计)。示例值:1 |
| FailCount | Integer | 失败的声纹数量(通常是因为声纹不存在)。示例值:1 |
| Results | Array of VoicePrintBatchDeleteResult | 每个 VoicePrintId 的处理结果列表,元素为 VoicePrintBatchDeleteResult。结构:{ VoiceprintId:string, ErrorCode:string, ErrorMessage:string },成功项仅返回 VoiceprintId,失败项带 ErrorCode/ErrorMessage。 |
| Message | String | 结果描述,成功时为 batch delete completed: X succeeded, Y failed。示例值:batch delete completed: 1 succeeded, 1 failed |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
VoicePrintBatchDeleteResult
| 名称 | 类型 | 必选 | 描述 |
| VoicePrintId | String | 否 | 本项对应的声纹 ID。成功项与失败项均会返回。示例值:19dbb1d12cd_9610feccb7dc4548910724f3f78a2d9d |
| ErrorCode | String | 否 | 本项失败时的错误码,成功项为空。常见值:FailedOperation.VoicePrintNotFound(声纹不存在或已删除)、InvalidParameterValue.InvalidVoicePrintId(ID 格式非法)。示例值:FailedOperation.VoicePrintNotFound |
| ErrorMessage | String | 否 | 本项失败时的错误描述,成功项为空。示例值:voiceprint not found |
四、输入示例
POST / HTTP/1.1Host: trtc.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: BatchDeleteTRTCVoicePrint<公共请求参数>{ "VoicePrintIds": [ "19fcc9aee0d_d063c3fa8f7848ae946e34a9e23311f4", "19fcc9b6948_f032467c97544b81b4bc170e8cb47a4e", "19fcc9b8a49_ef28c99807594da39b558f16e5a37b9c" ], "SdkAppId": "1400012345"}
五、输出示例
{ "Response": { "FailCount": 0, "Message": "batch delete completed: 3 succeeded, 0 failed", "RequestId": "1d32646f-c026-443b-a8d8-61c30f45084a", "Results": [ { "ErrorCode": "", "ErrorMessage": "", "VoicePrintId": "19fcc9aee0d_d063c3fa8f7848ae946e34a9e23311f4" }, { "ErrorCode": "", "ErrorMessage": "", "VoicePrintId": "19fcc9b6948_f032467c97544b81b4bc170e8cb47a4e" }, { "ErrorCode": "", "ErrorMessage": "", "VoicePrintId": "19fcc9b8a49_ef28c99807594da39b558f16e5a37b9c" } ], "SuccessCount": 3 }}
六、腾讯云 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 | 访问数据库失败。 |
| InvalidParameterValue.ErrorInvalidAppid | AppId 无效。 |
| InvalidParameterValue.InvalidSdkAppId | 无效的 SdkAppId。 |
| InvalidParameterValue.InvalidVoicePrintId | 无效的 VoicePrintId(为空、格式非法或批量数量超限)。 |