Skip to main content
WSS

说明

基于 WebSocket 的实时文本到语音合成接口,支持增量式文本输入与流式音频输出,适用于实时对话、在线客服、边生成边播报等低延迟场景。单次连接支持多次合成任务,最大文本长度 10000 字符。
  • 接入地址wss://api.senseaudio.cn/ws/v1/t2a_v2
  • 鉴权方式:Bearer Token,格式 Authorization: Bearer SENSEAUDIO_API_KEY
  • 消息格式application/json,音频仅返回 hex 编码字符串
  • 计费单位:按合成字符数计费,详见 计费说明
  • 音色入参voice_id 必须为当前账号可用音色,参考 音色列表
  • 标准 HTTP 合成:参考 语音合成 HTTP
  • SSE 合成:参考 语音合成 HTTP 流式
  • WebSocket 接口只支持返回 hex 格式 的音频数据。
  • 当最后一次收到服务端返回结果后超过 120 秒 没有发送新事件时,WebSocket 连接自动断开。
  • 音色模型名称:senseaudio-tts-1.5-260319

请求头 (Request Headers)


通信流程


客户端事件

1. task_start - 开始任务

发送此事件正式开始合成任务。当服务端返回 task_started 事件时,标志着任务已成功开始。只有在接收到该事件后,才能向服务器发送 task_continuetask_finish 事件。 请求参数 请求示例
响应参数 响应示例

2. task_continue - 任务继续

当收到服务端返回的 task_started 事件后,任务正式开始,可通过发送 task_continue 事件发送要合成的文本。支持顺序发送多个 task_continue 事件,实现分段文本合成。 请求参数

LaTeX 公式说明

控制是否朗读 latex 公式,默认为 false。
  • 请求中的公式需要在公式的首尾加上 $$
  • 请求中公式若有 \,需转义成 \\
示例:动能公式 动能公式 表示为:$$E_k = \\frac{1}{2} m v^2$$

<break> 停顿符说明

<break> 用于在语音合成中插入停顿。
  • time 单位为毫秒(ms)
  • 500 表示停顿 500 毫秒
  • 最小值为 100 毫秒,最大值无限制
示例:

dictionary (多音字纠正)

请求示例
响应参数 响应示例

3. task_finish - 结束任务

服务端收到此事件后,会等待当前队列中所有合成任务完成后,关闭 WebSocket 连接并结束任务。 请求参数 请求示例
响应示例

服务端事件

connected_success - 连接建立成功

初次请求接口时,表示 WebSocket 连接建立成功。

task_started - 任务已开始

标志任务已成功开始,客户端可以开始发送 task_continue 事件。

task_finished - 任务已结束

标志任务已结束,WebSocket 连接即将关闭。

task_failed - 任务失败

标志任务失败,base_resp.status_msg 中包含错误信息。

使用示例

依赖:npm install ws

技术规格

  • 模型名称senseaudio-tts-1.5-260319
  • 最大文本长度:10000 字符
  • 连接超时:最后一次收到服务端返回后 120 秒无新事件时自动断开

音频参数范围

支持的音频格式

  • MP3:推荐,压缩率高,兼容性好。
  • WAV:无损音质,文件较大。
  • PCM:原始音频数据。
  • FLAC:无损压缩。

错误码说明


注意事项

  1. 音频数据格式:WebSocket 接口只支持返回 hex 编码的音频数据,需要在客户端将 hex 字符串转换为二进制数据;音频格式由 audio_setting.format 决定。
  2. 连接超时机制:最后一次收到服务端返回后 120 秒内无新事件发送时连接自动断开;建议在任务完成后主动发送 task_finish,长时间无操作时可发送心跳保持连接。
  3. 事件发送顺序:必须按照 task_start → task_continue → task_finish 顺序发送;只有在收到 task_started 后才能发送 task_continue;可以发送多个 task_continue 事件。

相关资源

语音合成 HTTP

标准 HTTP 合成接口参数详解。

语音合成 HTTP 流式

流式 HTTP 合成接口参数详解。

语音合成介绍

TTS 核心特性与音色生态。

音色列表

系统音色清单与 voice_id 规则。
bearerAuth
type:http

Bearer Token 鉴权,格式 Authorization: Bearer <SENSEAUDIO_API_KEY>

task_start
type:object

开始合成任务

task_continue
type:object

发送待合成文本

task_finish
type:object

结束合成任务

connected_success
type:object

连接建立成功

task_started
type:object

任务已开始

task_continued

音频分片返回

task_finished
type:object

任务已结束

task_failed
type:object

任务失败