1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
同步接口。查询可用音色,支持通过类型、标签、语言等条件检索音色
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVoices。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| VoiceType | 否 | String | 音色类别 枚举值:
示例值:system |
| ExtParam | 否 | String | 扩展参数,json字符串 其他筛选条件voiceName String 音色名,模糊匹配labels Array of String 标签,匹配包含这些标签的音色 示例值:{ "labels": ["温柔"] } |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorCode | Integer | 错误码,成功时返回0 示例值:0 |
| Msg | String | 错误信息,成功时返回success 示例值:success |
| Voices | Array of VoiceInfo | 可用音色列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询所有可用音色
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoices
<公共请求参数>
{}
输出示例
{
"Response": {
"ErrorCode": 0,
"Msg": "success",
"Voices": [
{
"AudioUrl": "https://ie-mps-1258344699.cos.ap-nanjing.myqcloud.com/common/lauriehuang/dubbing/voice/samples/s1_ffgIs_z6m.wav",
"Category": "system",
"Description": "一位沉稳可靠的中年男性高管声音,标准普通话,传递出值得信赖的感觉。",
"Gender": "male",
"Labels": [
"沉稳"
],
"Languages": [
"zh"
],
"Name": "沉稳高管",
"Scenes": [
"通用"
],
"VoiceId": "s1_ffgIs/z6m/4N0fS1/MSotjeSxrtaVMTXMovoBjRATytSYVzhffFMWxq4pnx36Mq75Sh/v6d5smsJaA7z8w=="
}
],
"RequestId": "885d40d0-328a-429c-8394-527111536784"
}
}
示例2 根据标签查询音色
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoices
<公共请求参数>
{
"VoiceType": "system",
"ExtParam": "{\n \"labels\": [\"温柔\"]\n}"
}
输出示例
{
"Response": {
"ErrorCode": 0,
"Msg": "success",
"Voices": [
{
"AudioUrl": "https://ie-mps-1258344699.cos.ap-nanjing.myqcloud.com/common/lauriehuang/dubbing/voice/samples/s1_wXuUdY32P.wav",
"Category": "system",
"Description": "一位温和善良的中年大婶声音,标准普通话,温暖而体贴。",
"Gender": "female",
"Labels": [
"温柔"
],
"Languages": [
"zh"
],
"Name": "热心大婶",
"Scenes": [
"通用"
],
"VoiceId": "s1_wXuUdY32PfFMzV4mcz9qoIK9c4lKMWCzs+bdPaQ4//v+GnH0M9P4lXtue27Z3tCMtNOCYSnffKMmj3Y1gQ=="
}
],
"RequestId": "1941cce3-628c-4201-93ec-5463750181ff"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。