1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
异步语音合成
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AsyncTextToSpeech。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Text | 是 | String | 需要转语音的文字内容,最大允许50000字符,注意 1汉字=2字符 示例值:你好 |
| Voice | 是 | Voice | 文本转语音的声音配置 |
| SdkAppId | 是 | Integer | TRTC的SdkAppId 示例值:1600019222 |
| AudioFormat | 否 | AudioFormat | 文本转语音的输出音频的格式 |
| Model | 否 | String | TTS的模型,当前固定为:flow_01_turbo 示例值:flow_01_turbo |
| PronunciationDict.N | 否 | Array of PronunciationDict | 多音字/生僻字发音纠正词典条目。指定特定词语在本次请求中使用的发音。 |
| AlignmentMode | 否 | Integer | 默认为0,0表示不生成字幕,1表示生成字幕 示例值:0 |
| LanguageCode | 否 | String | 需要合成的语言(ISO 639-1),默认自动识别,支持的语言如下: zh(中文) en(英文) yue(粤语) ja(日语) ko(韩语) ar(阿拉伯语) id(印尼语) th(泰语) 示例值:zh |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID 示例值:3d5f26c1-9-f*883e-b543337b8eab |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开启异步任务
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AsyncTextToSpeech
<公共请求参数>
{
"Text": "你好",
"Voice": {
"VoiceId": "v-female-R2s4N9qJ"
},
"SdkAppId": 1600019222,
"AlignmentMode": 1,
"LanguageCode": "zh"
}
输出示例
{
"Response": {
"TaskId": "3d5f26c1-**9*-*f***883e-b543337b8eab",
"RequestId": "dcbccd58-c660-4546-b4fa-522d9223556e"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.TextLength | 无效的文本长度 |
| UnsupportedOperation.TaskLimit | 任务并发限制 |