基于 WebSocket 的双向流式 TTS 接口，支持文本流式输入、音频流式输出，低时延，适用于实时交互场景，覆盖多语种与多方言。 > **运行依赖文件** > TTS Websocket Bidirection protocols.zip --- ## 请求 **请求路径** `wss://openspeech.bytedance.com/api/v3/tts/bidirection` ### 请求头 **X\-Api\-Key ** `string` 必选 API Key 可以从 [控制台>API Key管理](https://console.volcengine.com/speech/new/setting/apikeys?projectName=default.) 获取注意： * 本接口同时支持[旧版控制台](https://console.volcengine.com/speech/service/10035)的鉴权方式，详见[旧版控制台鉴权参考](https://www.volcengine.com/docs/6561/2534847?lang=zh) **X\-Api\-Resource\-Id ** `string` 必选请求的模型版本，可选值： * `seed-tts-2.0`:豆包语音合成大模型2.0，支持使用[豆包语音合成模型2.0音色](https://www.volcengine.com/docs/6561/1257544?lang=zh#%E8%B1%86%E5%8C%85%E8%AF%AD%E9%9F%B3%E5%90%88%E6%88%90%E6%A8%A1%E5%9E%8B2-0-%E9%9F%B3%E8%89%B2%E5%88%97%E8%A1%A8) * `seed-icl-2.0`:豆包声音复刻大模型2.0，支持使用声音复刻接口克隆的音色，具体音色详见[控制台>音色库](https://console.volcengine.com/speech/new/voices?projectName=default) **X\-Api\-Connect\-Id** `string` 用于追踪当前连接情况的标志 ID **X\-Control\-Require\-Usage\-Tokens\-Return ** `string` 若设置为`*`，会返回计费的字符数 ### 事件 **建立连接** **EventType ** `string` 请求事件类型。建立连接时，字段固定为`StartConnection` **创建会话** **EventType ** `string` 请求事件类型。创建会话时，字段固定为`StartSession` **session_id ** `string` 合成会话id，由客户端生成 **req_params ** `object` 必选 **model** `string` 具体模型版本，当`speaker`参数为复刻音色时使用，可选值： * `seed-tts-2.0-standard` * 标准版模型，时延更低 * 不支持使用语音指令`context_texts` * 不支持使用语音标签`use_tag_parser` * `seed-tts-2.0-expressive` * 高表现力版本，但是生成稳定较低，存在效果波动 * 支持使用语音指令`context_texts` * 支持使用语音标签`use_tag_parser` 默认值：`seed-tts-2.0-standard` **speaker** `string` 必选音色 ID，可从[控制台 > 音色库](https://console.volcengine.com/speech/new/voices?projectName=default)获取 **ssml** `string` SSML 标记文本，启用后按 SSML 规则解析 `text` * 目前仅中英文音色支持ssml，音色详见：[豆包语音合成模型2.0音色](https://www.volcengine.com/docs/6561/1257544?lang=zh#%E8%B1%86%E5%8C%85%E8%AF%AD%E9%9F%B3%E5%90%88%E6%88%90%E6%A8%A1%E5%9E%8B2-0-%E9%9F%B3%E8%89%B2%E5%88%97%E8%A1%A8) 详见：[SSML标记语言](https://www.volcengine.com/docs/6561/1330194?lang=zh) **audio_params** `object` 必选音频参数 **format** `string` 音频格式，支持 `mp3` / `pcm` / `ogg_opus` / `wav` 默认值：`mp3` 注意：流式场景推荐使用`pcm`，不建议使用`wav` **sample_rate** `int` 音频采样率，单位 Hz，可选值： [`8000`,`16000`,`22050`,`24000`,`32000`,`44100`,`48000`] **bit_rate** `int` 音频比特率，单位 bps，默认范围[`64000`,`160000`] 注意：该参数仅对 `mp3` 格式的音频生效 **speech_rate** `int` 语速，取值范围 [`-50`, `100`]，其中，取值`100`代表2.0倍速，`-50`代表0.5倍速 **loudness_rate** `int` 音量，取值范围 [`-50`, `100`]，其中，取值`100`代表2.0倍音量，`-50`代表0.5倍音量 **enable_subtitle** `bool` 是否开启字幕服务，开启后，返回字级别的时间戳可选值：`true`, `false` 默认值：`false` 注意： * 仅豆包语音合成大模型2.0支持该参数 * 目前该参数仅支持中文、英文 **additions** `string` **disable_markdown_filter**`bool` 是否开启 Markdown解析过滤 `true`：开启过滤，会解析并去除 Markdown 语法。例如" \*\*你好\*\* "朗读为 "你好" `false`：关闭过滤，保留原始字符。例如 " \*\*你好\*\* " 朗读为 "星星你好星星" 默认值：`false` **disable_emoji_filter** `bool` 是否开启Emoji解析过滤可选值：`true`, `false` 默认值：`false` **enable_latex_tn** `bool` 是否启用 Latex文本朗读能力可选值：`true`, `false` 默认值：`false` **latex_parser** `string` 是否启用更强的Latex文本朗读能力可选值：`v2` 注意： * 该参数适用于教育场景，启用该参数后，时延会增加 * 开启该参数时，需将`disable_markdown_filter`设置为`true` **explicit_language** `string` 显式指定朗读语种。开启后，仅朗读指定语种的文本，其他语种的内容会被跳过或合成失败，取值如下 * `zh-cn`：中文为主，支持中英混读 * `en`：仅朗读英语 * `ja`：仅朗读日语 * `es-mx`：仅朗读墨西哥语 * `id`：仅朗读印度尼西亚语 * `pt-br`：仅朗读巴西葡萄牙语 * `ko`：仅朗读韩语注意：启用该参数后，输入文本须包含指定语种的内容，否则请求将无法正常返回 **explicit_dialect** `string` 指定方言。注意：使用该参数时，`speaker`需要设置支持方言的音色，详见[音色列表](https://www.volcengine.com/docs/6561/1257544?lang=zh) **aigc_watermark** `bool` AIGC生成标识。开启后，会在音频合成结尾添加节奏标识默认值：`false` **aigc_metadata** `object` 在合成音频中添加meta水印，支持音频格式 `mp3` / `wav` / `ogg_opus` **enable ** `bool` 是否启用meta隐式水印默认值：`false` **content_producer**`string` 合成服务提供者的名称或编码 **produce_id ** `string` 内容制作编号 **content_propagator**`string` 内容传播服务提供者的名称或编码 **propagate_id ** `string` 内容传播编号 **cache_config** `object` 缓存相关配置 **text_type ** `int` 文本类型标识。需和`use_cache`一起使用，需要开启缓存时取`0` **use_cache ** `bool` 是否启用缓存。需和`text_type`一起使用，需要开启缓存时传`true` **post_process** `object` **pitch ** `int` 音调，取值范围`[-12,12]` **context_texts** `array` 语音指令。注意： * 当`spekaer`参数设置为[豆包语音合成模型2.0音色](https://www.volcengine.com/docs/6561/1257544?lang=zh#%E8%B1%86%E5%8C%85%E8%AF%AD%E9%9F%B3%E5%90%88%E6%88%90%E6%A8%A1%E5%9E%8B2-0-%E9%9F%B3%E8%89%B2%E5%88%97%E8%A1%A8)时，可直接使用语音指令 * 当`speaker`参数设置为复刻音色时，需将`model`参数设置为`seed-tts-2.0-expressive` * 该字段文本不参与计费示例： ```Python "context_texts":[ "你可以用特别特别痛心的语气说话吗?"] ``` **use_tag_parser** `bool` 是否开启语音标签cot解析能力。cot能力可以辅助当前语音合成，对语速、情感等进行调整。默认值：`false` 注意： * 仅复刻音色支持cot解析，需要将`speaker`设置为复刻音色 * 使用该参数时，需将`model`参数设置为`seed-tts-2.0-expressive` * 使用该参数时，`text`参数中字符长度最好小于64（包含语音标签）示例： ```Python 工作占据了生活的绝大部分，只有去做自己认为伟大的工作，才能获得满足感。不管生活再苦再累，都绝不放弃寻找。 ``` **发送请求** **EventType ** `string` 请求事件类型。发送请求时，字段固定为`TaskRequest` **session_id ** `string` 合成会话ID **text ** `string` 必选待合成的输入文本 **取消会话** **EventType ** `string` 请求事件类型。取消会话时，字段固定为`CancelSession` **结束会话** **EventType ** `string` 请求事件类型。结束会话时，字段固定为`FinishSession` **结束连接** **EventType ** `string` 请求事件类型。结束连接时，字段固定为`FinishConnection` ### 响应 **EventType** `string` 响应事件类型。包含以下几种事件 * `ConnectionStarted`：建连成功 * `SessionStarted`：会话开始 * `TTSSentenceStart`：开始合成音频 * `TTSResponse`：音频合成内容 * `TTSSentenceEnd`：音频合成结束 * `TTSSubtitle`：返回音频合成字幕 * `SessionFinished`：会话结束 * `ConnectionFinished`：连接结束 * `SessionCanceled`：会话取消 * `ConnectionFailed`：建连失败 * `SessionFailed`：会话失败 **MsgType ** `string` 消息类型。响应消息类型有以下两种 * `FullServerResponse` * `AudioOnlyServer` **session_id ** `string` 会话 ID，用于标识一次合成会话 **connect_id ** `string` 连接 ID，用于标识当前 WebSocket 连接 **payload ** `object` 当前事件携带的响应内容 **phonemes ** `object` 音素相关时间戳 **text ** `string` 合成音频文本 **words ** `object` 字级别时间戳 **confidence ** `float` 时间戳置信度，范围 0~1 **startTime ** `float` 开始时间（秒） **endTime ** `float` 结束时间（秒） **word ** `string` 字 **usage ** `object` 本次请求的资源消耗统计 **text_words ** `int` 本次请求计费的文本字数（含标点）