1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
发起语音合成任务,将文本合成为语音,面向长文本场景(最大 200000 字符),支持指定音色及语速、音量、音调、采样率、输出格式等合成参数。语音合成为异步任务,完成后产出音频结果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:TextToSpeechAsync。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Text | 是 | String | 语音合成文本 示例值:语音合成测试 |
| VoiceId | 是 | String | 音色ID 示例值:ttv-voice-20****26-qaFeULIp |
| SubAppId | 否 | String | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:260***028 |
| LanguageBoost | 否 | String | 语言增强,如 "zh" "en" "auto",默认 "auto" 示例值:zh |
| ExtParam | 否 | String | 文本合成语音(异步)拓展参数。ExtParam 支持的字段:
示例值:{"model":"minimax-speech-2.8-turbo","text_lang":"zh","audio_setting":{"speed":1.2,"vol":1.5,"pitch":2,"emotion":"happy","sample_rate":32000,"format":"mp3","duration":60,"cut_silence":false}} |
| Output | 否 | TextToSpeechAsyncOutputOption | 输出相关参数 可以指定输出形式等。默认输出音频url。 |
| SessionContext | 否 | String | 标识来源上下文,用于透传用户请求信息,在回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。 示例值:202410011900***tmsd |
| SessionId | 否 | String | 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 示例值:6bb56a09278***6dab783eff |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID,使用该ID查询结果 示例值:260085028-TextToSpeec****5b37f06c0e0b890c60ct |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 语音合成
语音合成
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TextToSpeechAsync
<公共请求参数>
{
"Text": "语音合成测试",
"VoiceId": "ttv-voice-20************26-qaFeULIp",
"SubAppId": "260***028",
"SessionId": "6bb56a09278***********6dab783eff"
}
输出示例
{
"Response": {
"TaskId": "260085028-TextToSpeec********************5b37f06c0e0b890c60ct",
"RequestId": "e6dd5ca8-43f2-4bcd-9f4a-4e58e4cb4e19"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。