WebSocket 接入指南

​

接口地址

WebSocket 接口使用 wss:// 协议，地址如下： wss://maas.qianwenaiapi.com/api-ws/v1/inference

​

请求头

请求头中需添加如下信息：

​

交互流程

客户端事件和服务端事件的详细说明，请参见客户端事件和服务端事件。 按时间顺序，客户端与服务端的交互流程如下：

1. 建立连接：客户端与服务端建立WebSocket连接。
2. 开启任务：客户端发送run-task事件以开启任务。
3. 等待确认：客户端收到服务端返回的task-started事件，标志着任务已成功开启，可以进行后续步骤。
4. 发送待合成文本： 客户端按顺序向服务端发送一个或多个包含待合成文本的continue-task事件，服务端接收到完整语句后返回result-generated事件和音频流（文本长度有约束， 详情参见continue-task事件中text字段描述）。
   支持多次发送continue-task事件，按顺序提交文本片段。服务端接收文本片段后自动进行分句：

   • 完整语句立即合成，此时客户端能够接收到服务端返回的音频
   • 不完整语句缓存至完整后合成，语句不完整时服务端不返回音频

   当发送finish-task事件时，服务端会强制合成所有缓存内容。
5. 接收音频：通过 binary 通道接收音频流
6. 通知服务端结束任务： 待文本发送完毕后，客户端发送finish-task事件通知服务端结束任务，并继续接收服务端返回的音频流。此步骤不可省略，否则可能导致语音数据不完整。
7. 任务结束： 客户端收到服务端返回的task-finished事件，标志着任务结束。
8. 关闭连接：客户端关闭WebSocket连接。

为提高资源利用率，建议复用 WebSocket 连接处理多个任务，而非为每个任务建立新连接。