1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
接口说明:
分页查询当前 (AppId, SdkAppId) 下的声纹列表。
• Offset/Limit 可选,默认从 0 起取 20 条,Limit 最大 100。
• TotalCount 为活跃状态声纹总数,用于分页控件计算总页数。
• 仅返回业务可见字段(VoiceprintId / SpeakerId / CreateTime / UpdateTime),不暴露内部 COS 路径。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTRTCVoicePrint。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| SdkAppId | 是 | String | SdkappId 示例值:1400123456 |
| Offset | 否 | Integer | 分页起始偏移,0 或不传表示从第一条开始 示例值:0 |
| Limit | 否 | Integer | 每页返回数量,默认 20,最大 100;超过最大值会被截断到 100 示例值:30 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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。 |
4. 示例
示例1 查询示例
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-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"
}
}
5. 开发者资源
腾讯云 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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.FailAccessDatabase | 访问数据库失败。 |
| InvalidParameterValue.ErrorInvalidAppid | AppId无效。 |
| InvalidParameterValue.InvalidSdkAppId | 无效的 SpeakerId。 |