一、接口描述
接口说明:
·Offset/Limit 可选,默认从 0 起取 20 条,Limit 最大 100。
·TotalCount 为活跃状态声纹总数,用于分页控件计算总页数。
·仅返回业务可见字段(VoiceprintId / SpeakerId / CreateTime / UpdateTime),不暴露内部 COS 路径。
注意:说明:
注意:默认接口请求频率限制:20次/秒。
二、输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:DescribeTRTCVoicePrint。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| SdkAppId | 是 | String | SdkAppId。示例值:1400123456 |
| Offset | 否 | Integer | 分页起始偏移,0 或不传表示从第一条开始。示例值:0 |
| Limit | 否 | Integer | 每页返回数量,默认 20,最大 100;超过最大值会被截断到 100。示例值:30 |
三、输出参数
| 参数名称 | 类型 | 描述 |
| TotalCount | Integer | 当前 (AppId, SdkAppId) 下的声纹总数(仅计活跃状态)。示例值:4 |
| VoicePrintList | Array of TRTCVoicePrintItem | 声纹条目列表,元素为 TRTCVoicePrintItem。结构:{ VoicePrintId:string, SpeakerId:string, CreateTime:string(ISO8601), UpdateTime:string(ISO8601) }。 |
| Message | String | 结果描述,成功时为 query voiceprint list successfully。示例值:query voiceprint list successfully |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
TRTCVoicePrintItem
| 名称 | 类型 | 必选 | 描述 |
| VoicePrintId | String | 否 | 声纹 ID,36 位 UUID(含连字符)。对 (AppId, SdkAppId) 维度内唯一。示例值:59d83c76-8f4e-4a1b-9c2d-0e7f8a6b5c4d示例值:19dbb727a75_f3be637f9fda4c10b5b466d28285efba |
| SpeakerId | String | 否 | 业务方自定义的说话人标识,长度不超过 128 字节,由客户在注册声纹时传入。同一 SpeakerId 可对应多条声纹。示例值:user_12345示例值:user4 |
| CreateTime | String | 否 | 声纹注册时间,ISO8601 格式,UTC 时区。示例值:2025-04-24T10:20:30Z示例值:2026-04-24T01:45:35+08:00 |
| UpdateTime | String | 否 | 声纹最近一次更新时间,ISO8601 格式,UTC 时区。未被更新过时等于 CreateTime。示例值:2025-04-24T10:20:30Z示例值:2026-04-24T01:45:35+08:00 |
四、输入示例
POST / HTTP/1.1Host: trtc.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeTRTCVoicePrint<公共请求参数>{ "SdkAppId": "1400123456", "Offset": 0, "Limit": 30}
五、输出示例
{ "Response": { "Message": "query voiceprint list successfully", "TotalCount": 4, "VoicePrintList": [ { "CreateTime": "2026-04-24T01:45:35+08:00", "SpeakerId": "user4", "UpdateTime": "2026-04-24T01:45:35+08:00", "VoicePrintId": "19dbb727a75_f3be637f9fda4c10b5b466d28285efba" } ], "RequestId": "a14eb21b-8e78-46a0-baad-46e1ab952e95" }}
六、腾讯云 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
十、错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| InternalError.FailAccessDatabase | 访问数据库失败。 |
| InvalidParameterValue.ErrorInvalidAppid | AppId 无效。AppId 是你腾讯云账号的唯一标识,接口会根据你的密钥信息自动获取,无需在参数中传递。 |
| InvalidParameterValue.InvalidSdkAppId | 无效的 SdkAppId。 |