云点播同步语音合成

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

发起语音合成任务，将文本合成为语音。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：TextToSpeechSync。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
Text	是	String	合成文本，语音合成时必填，文本长度不超过2000字节示例值：种子在土里沉默，是为了破土时的惊雷。
VoiceId	是	String	音色Id，指定音色合成时填写，支持系统音色和设计、克隆音色。示例值：minimax_5*527-4dff
SubAppId	否	String	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：221***
LanguageBoost	否	String	语言增强，如 "zh" "en" "auto"，默认 "auto" 示例值：zh
Output	否	TextToSpeechSyncOutputOption	输出相关参数可以指定输出形式等。默认输出音频URL。
ExtParam	否	String	同步语音合成拓展参数。`ExtParam` 支持的字段： `model` (string)：合成模型，可选 `minimax-speech-2.8-hd`、`minimax-speech-2.8-turbo`、`minimax-speech-2.6-hd`、`minimax-speech-2.6-turbo`、`minimax-speech-02-hd`、`minimax-speech-02-turbo`；默认 `minimax-speech-2.8-hd`。 `voice_setting` (object)：音色微调，可选字段： `speed` (float)：语速，`[0.5, 2.0]`，默认 `1.0`。 `vol` (float)：音量，`(0, 10]`，默认 `1.0`。 `pitch` (int)：音调，`[-12, 12]`，默认 `0`。 `emotion` (string)：情绪，可选 `happy` / `sad` / `angry` / `fearful` / `disgusted` / `surprised` / `calm` / `fluent` / `whisper`。 `audio_setting` (object)：音频输出参数，可选字段： `sample_rate` (int)：采样率，可选 `8000` / `16000` / `22050` / `24000` / `32000` / `44100`，默认 `16000`。 `format` (string)：音频格式，可选 `mp3` / `wav`，默认 `wav`。 `duration` (float)：目标时长（秒）。 `cut_silence` (bool)：是否裁剪静音段。示例值：{"model": "minimax-speech-2.8-hd", "voice_setting": {"speed": 2.0, "vol": 2.0}, "audio_setting": {"sample_rate": 32000, "bitrate": 128000, "format": "mp3"}}

3. 输出参数

参数名称	类型	描述
AudioData	String	合成音频的base64编码，wav格式。示例值：UklGRnxuAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVF4EAABJTkZPSUNNVDwEAABBSUdDP****GIzZGFiODAwZjNlYzc4N2Q3MjZhMmQyNDYyIiwiUmVzZXJ2ZWRDb2RlMSI6IntcIlNlY3VyaXR5RGF0Y
AudioUrl	String	合成音频url，有效期24小时示例值：https://laurie-tmp-1300828900.cos.a***********************************b70-c745-4335-bbfc-b2f6c00ac0b2.mp3
ExtInfo	String	扩展信息，json字符串 duration: 结果音频时长，单位秒示例值：{"audio_format":"mp3","audio_length":1836,"audio_sample_rate":32000,"audio_size":0,"word_count":16}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 同步语音合成

同步语音合成

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TextToSpeechSync
<公共请求参数>

{
    "Text": "种子在土里沉默，是为了破土时的惊雷。",
    "VoiceId": "minimax_5*********527-4dff",
    "LanguageBoost": "zh",
    "ExtParam": "{\"model\": \"minimax-speech-2.8-hd\", \"voice_setting\": {\"speed\": 2.0, \"vol\": 2.0}, \"audio_setting\": {\"sample_rate\": 32000, \"bitrate\": 128000, \"format\": \"mp3\"}}",
    "SubAppId": "221***"
}

输出示例

{
    "Response": {
        "AudioData": "",
        "AudioUrl": "https://laurie-tmp-1300828900.cos.a***********************************b70-c745-4335-bbfc-b2f6c00ac0b2.mp3",
        "ExtInfo": "{\"audio_format\":\"mp3\",\"audio_length\":1836,\"audio_sample_rate\":32000,\"audio_size\":0,\"word_count\":16}",
        "RequestId": "a24cdb70-c745-4335-bbfc-b2f6c00ac0b2"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。