1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
按音色 ID 更新音色的画像信息(名称、描述、性别、年龄、语言、标签、场景等),返回更新后的完整音色信息。仅支持更新本账号下的音色,系统预置音色不支持更新。
注意:新设计、克隆的音色未被激活前无法被更新,需首次使用该新建音色执行一次 TTS 后才被激活。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateVoice。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| VoiceId | 是 | String | 音色Id 示例值:v1_aBbiY3aN7tm7ff3S1gBZa****plXzQDwNTiJQp2aYilZGv0= |
| VoiceFields | 是 | VoiceUpdateFields | 更新音色字段 |
| SubAppId | 否 | String | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:260***028 |
| ExtParam | 否 | String | 扩展参数,json字符串 示例值:{"engine": "auto"} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Voice | VoiceInfo | 更新后的音色信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新音色信息
更新音色信息
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateVoice
<公共请求参数>
{
"SubAppId": "260***028",
"VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZa************************plXzQDwNTiJQp2aYilZGv0=",
"VoiceFields": {
"Name": "音色",
"Description": "音色简介",
"Gender": "male",
"Age": "middle_aged",
"Languages": [
"zh"
],
"Labels": [
"知性"
],
"Scenes": [
"通用"
],
"AudioUrl": "https://laurie-tmp-1300828900.cos.ap-nanjing.myqcloud.com/sync_dubbing/27111c32-93e3-476e-8ab5-e7fb5838f994.wav"
},
"ExtParam": "{\"engine\": \"auto\"}"
}
输出示例
{
"Response": {
"Voice": {
"Age": "middle_aged",
"AudioUrl": "",
"Category": "clone",
"Description": "音色简介",
"Gender": "male",
"Labels": [
"知性"
],
"Languages": [
"zh"
],
"Name": "音色",
"Scenes": [
"通用"
],
"VoiceId": "v1_aBbiY3aN7tm7ff3S1gBZamsLQyEsQswXoEpreGEStjnx2plXzQDwNTiJQp2aYilZGv0="
},
"RequestId": "83593c53-3379-4359-a25b-815bb562bf37"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。