{"componentChunkName":"component---src-templates-acg-portal-new-template-tsx","path":"/Vmwbl4d4c","result":{"data":{"markdownRemark":{"html":"

接口描述

\n

流式文本在线合成基于websocket协议，可以将输入的文本合成为二进制格式的语音数据。与发起多次短文本语音合成相比，可以获得更高的实时性，在用户输入文本的同时就能接近同步的返回合成音频数据，达到“边合成边播放”的效果。

\n

功能说明

\n\n

示例代码

\n

流式语音合成示例：TTS-ws-demo.zip\n

\n

接口调用主流程

\n

交互流程

\n

\"image.png\"

\n

握手建立连接

\n

连接请求

\n

握手阶段，客户端主动发起 websocket 连接请求

\n

请求地址

\n

请求地址：wss://aip.baidubce.com/ws/2.0/speech/publiccloudspeech/v1/tts

\n

请求参数

\n

URL中放置请求参数，参数如下：

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型参数位置是否必填备注
access_tokenstringquery二选一鉴权令牌
Authorizationstringheader二选一鉴权API Key
perstringquery必填tts发音人
\n

请求示例

\n\n
\n
\n
\n Text\n \n
\n
\n 
1curl --location 'wss://aip.baidubce.com/ws/2.0/speech/publiccloudspeech/v1/tts?access_token=xxx&per=xxx'
\n
\n
\n
\n \n

连接响应

\n

如果握手成功，会返回 101状态码，表示协议握手成功；如果握手失败，则根据不同错误类型返回不同 http status，详细说明如下：
\n成功：状态码101 Switching Protocols
\n失败：错误码及描述如下

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
状态码状态信息描述解决方案
400Bad Request参数错误、参数缺失请参考官网文档，自查token和per
401Unauthorized鉴权失败
403Forbidden无访问权限，接口功能未开通
404Not Found输入的url错误
429Too Many Requests触发限流
500Internal Server Error服务器内部错误
502Bad Request后端服务连接失败
\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1429 Too Many Requests\n2\n3{\n4    "code": 276001,\n5    "message": "Rate limit exceeded error"\n6}
\n
\n
\n
\n \n
参数说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型是否必填说明
codeint必填错误码， 使用能力引擎标准的错误码
messagestring必填错误消息
\n

初始化

\n

握手成功后客户端和服务端会建立websocket连接，客户端通过websocket连接可以同时上传和接收数据。

\n

客户端请求参数

\n\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type": "system.start",\n3    "payload": {\n4        "spd": 5,\n5        "pit": 5,\n6        "vol": 5,\n7        "audio_ctrl": '{"AIGC": {"ContentPropagator":"XXX","PropagateID":"XXX"},"sampling_rate":16000}',\n8        "aue": 3\n9    }\n10}
\n
\n
\n
\n \n
参数说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
typestring必填开始帧的类型，固定值 system.start
payloadobject可选合成参数，详见下表
\n
payload 字段说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
spdint可选语速，取值 0-15，默认为 5
pitint可选音调，取值 0-15，默认为 5
volint可选音量，基础音库取值0-9，其他音库取值 0-15，默认为 5
aueint可选音频格式，3=mp3-16k/24k，4=pcm-16k/24k，5=pcm-8k，6=wav-16k/24k，默认为3
audio_ctrlstring可选 sampling_rate: 采样率,仅支持降采样,示例 {\"sampling_rate\":16000}
 AIGC: 元数据标识，仅支持mp3格式音频添加，默认不添加。
示例：{ \"ContentPropagator\":\"内容传播服务提供者\", \"PropagateID\":\"内容传播编号\" }
ContentPropagator、PropagateID请传入string类型的数据。
若不传入两个字段，默认不添加元数据标识；传入字段后音频header将添加Label、ContentProducer、ProduceID、ContentPropagator、PropagateID总计5个字段。
\n

服务端响应

\n\n

正常响应

\n\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type": "system.started",\n3    "code": 0,\n4    "message": "success",\n5    "headers": {\n6        "session_id": "xxx"\n7               }\n8}
\n
\n
\n
\n \n
参数说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
typestring必填固定值 system.started，表示开始帧的类型
codeint必填错误码，0 表示成功
messagestring必填错误信息
headersobject必填系统定义的请求头
+ session_idstring必填sn 信息，格式为 [0-9a-zA-Z_-]{1,64}
\n

异常响应

\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type": "system.started",\n3    "code": 216100,\n4    "message": "语速参数错误, 请输入0-15的整数",\n5    "headers": {\n6        "session_id": "xxx"\n7               }\n8}
\n
\n
\n
\n \n
异常响应列表
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
typecodemessage说明
system.started216100参数错误参数类型错误
system.started216100语速参数错误, 请输入0-15的整数语速取值超限
system.started216100音调参数错误, 请输入0-15的整数音调取值超限
system.started216100基础音库音量参数错误, 请输入0-9的整数基础音库音量取值超限
system.started216100精品/臻品音库音量参数错误, 请输入0-15的整数精品/臻品音库音量取值超限
system.started216100音频格式错误, 3:mp3, 4:pcm-16k, 5:pcm-8k, 6:wav音频格式取值错误
\n

不响应

\n\n

发送文本

\n

客户端请求

\n\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type": "text",\n3    "payload": {\n4        "text": "需要进行语音合成的文字"\n5    }\n6}
\n
\n
\n
\n \n
参数说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
typestring必填数据帧的类型，固定值 text
payloadarray可选具体见下表
\n
payload 字段说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
+ textstring必填需要进行语音合成的文字，不超过1000字
\n

服务端响应

\n

正常响应

\n\n
\n
\n
\n Text\n \n
\n
\n 
1WebSocket opcode`：`binary\n2WebSocket消息体：音频二进制数据
\n
\n
\n
\n \n

异常响应

\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type": "system.error",\n3    "code": 216103,\n4    "message": "文本过长, 请控制在1000字以内",\n5    "headers": {\n6        "session_id": "xxx"\n7    }\n8}
\n
\n
\n
\n \n
异常响应列表-文本限制说明
\n
    \n
  1. 单次发送文本不超过1000汉字，若超过，下发提示帧【文本过长，请控制在1000字以内】
    2. \n
  2. 未处理文本长度超过10000汉字后不处理新增文本，下发提示帧【当前待处理文本过长，请稍后发送】
    3. \n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
typecodemessage说明
text216101参数缺失缺少必需的参数
text216103文本过长, 请控制在1000字以内单次文本不能超过1000字
text216419当前待处理文本过长，请稍后发送发送频率过快，待处理文本过长
\n

不响应

\n\n

其他响应

\n\n\n
\n
\n
\n Text\n \n
\n
\n 
1, . 、? ! : ; ， 。 ？ ！ ： ； — …
\n
\n
\n
\n \n\n

结束合成

\n

客户端请求

\n\n

正常响应

\n\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type":"system.finish",\n3}
\n
\n
\n
\n \n
参数说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
typestring必填结束帧的类型，固定值 system.finish
\n

服务端响应

\n\n

正常响应

\n\n
示例
\n\n
\n
\n
\n Text\n \n
\n
\n 
1{\n2    "type":"system.finished",\n3    "code": 0,\n4    "message": "success",\n5}
\n
\n
\n
\n \n
参数说明
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必填说明
typestring必填结束帧的类型，固定值 system.finished
codeint必填错误码，0表示成功
messagestring必填错误信息
\n

异常响应

\n

暂无

\n

不响应

\n\n

断开连接

\n

正常断开

\n

服务端响应结束合成后，会主动断开连接

\n

异常断开

\n

客户端超过一分钟不发送消息，服务端会异常断开连接

","fields":{"slug":"Vmwbl4d4c","title":"流式文本在线合成","date":"2026-11-11","extractedHeadings":[]},"headings":[{"value":"接口描述","depth":1},{"value":"功能说明","depth":2},{"value":"示例代码","depth":2},{"value":"接口调用主流程","depth":1},{"value":"交互流程","depth":2},{"value":"握手建立连接","depth":2},{"value":"连接请求","depth":3},{"value":"请求地址","depth":4},{"value":"请求参数","depth":4},{"value":"请求示例","depth":4},{"value":"连接响应","depth":3},{"value":"示例","depth":5},{"value":"参数说明","depth":5},{"value":"初始化","depth":2},{"value":"客户端请求参数","depth":3},{"value":"示例","depth":5},{"value":"参数说明","depth":5},{"value":"payload 字段说明","depth":6},{"value":"服务端响应","depth":3},{"value":"正常响应","depth":4},{"value":"示例","depth":5},{"value":"参数说明","depth":5},{"value":"异常响应","depth":4},{"value":"示例","depth":5},{"value":"异常响应列表","depth":5},{"value":"不响应","depth":4},{"value":"发送文本","depth":2},{"value":"客户端请求","depth":3},{"value":"示例","depth":5},{"value":"参数说明","depth":5},{"value":"payload 字段说明","depth":6},{"value":"服务端响应","depth":3},{"value":"正常响应","depth":4},{"value":"异常响应","depth":4},{"value":"示例","depth":5},{"value":"异常响应列表-文本限制说明","depth":5},{"value":"不响应","depth":4},{"value":"其他响应","depth":4},{"value":"结束合成","depth":2},{"value":"客户端请求","depth":3},{"value":"正常响应","depth":4},{"value":"示例","depth":5},{"value":"参数说明","depth":5},{"value":"服务端响应","depth":3},{"value":"正常响应","depth":4},{"value":"示例","depth":5},{"value":"参数说明","depth":5},{"value":"异常响应","depth":4},{"value":"不响应","depth":4},{"value":"断开连接","depth":2},{"value":"正常断开","depth":3},{"value":"异常断开","depth":3}]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"Vmwbl4d4c","prev":{"id":"2mwbl4d2n","name":"长文本语音合成-提交任务","path":"2mwbl4d2n","filePath":"模型/推理API（数据面）/在线推理/语音/语音合成/长文本语音合成-提交任务.md","seo":null,"parentIds":["Zmwbl43s8","xmwbl4528","Nmwbl45c6","Lmwbl4964","amwbl4cvl"],"parents":[{"id":"Zmwbl43s8","documentId":"0098c3f5-6f86-4ca0-ba61-8c65e07a87a5","name":"模型","repoName":"qianfan-api","filePath":"模型","disabled":false,"path":"Zmwbl43s8","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"xmwbl4528","documentId":"202d7dd2-1164-424e-98f5-69ab44721f8a","name":"推理API（数据面）","repoName":"qianfan-api","filePath":"模型/推理API（数据面）","disabled":false,"path":"xmwbl4528","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"Nmwbl45c6","documentId":"985bba32-c873-4e13-9148-0631067ca278","name":"在线推理","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理","disabled":false,"path":"Nmwbl45c6","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"Lmwbl4964","documentId":"238db9ce-a1e9-4ed4-a3d7-5138c285ae5a","name":"语音","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理/语音","disabled":false,"path":"Lmwbl4964","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"amwbl4cvl","documentId":"c4330d83-2370-4779-b2ce-65e3bb0b5c7f","name":"语音合成","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理/语音/语音合成","disabled":false,"path":"amwbl4cvl","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"next":{"id":"wmwbl4d5z","name":"语音识别","path":"wmwbl4d5z","filePath":"模型/推理API（数据面）/在线推理/语音/语音识别/音频文件转写-查询结果.md","seo":null,"parentIds":["Zmwbl43s8","xmwbl4528","Nmwbl45c6","Lmwbl4964","dmwbl4d5r"],"parents":[{"id":"Zmwbl43s8","documentId":"0098c3f5-6f86-4ca0-ba61-8c65e07a87a5","name":"模型","repoName":"qianfan-api","filePath":"模型","disabled":false,"path":"Zmwbl43s8","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"xmwbl4528","documentId":"202d7dd2-1164-424e-98f5-69ab44721f8a","name":"推理API（数据面）","repoName":"qianfan-api","filePath":"模型/推理API（数据面）","disabled":false,"path":"xmwbl4528","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"Nmwbl45c6","documentId":"985bba32-c873-4e13-9148-0631067ca278","name":"在线推理","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理","disabled":false,"path":"Nmwbl45c6","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"Lmwbl4964","documentId":"238db9ce-a1e9-4ed4-a3d7-5138c285ae5a","name":"语音","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理/语音","disabled":false,"path":"Lmwbl4964","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"dmwbl4d5r","documentId":"9eeb09fe-e077-4a12-b59f-58d58ff2dbab","name":"语音识别","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理/语音/语音识别","disabled":false,"path":"dmwbl4d5r","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"parents":[{"id":"Zmwbl43s8","documentId":"0098c3f5-6f86-4ca0-ba61-8c65e07a87a5","name":"模型","repoName":"qianfan-api","filePath":"模型","disabled":false,"path":"Zmwbl43s8","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"xmwbl4528","documentId":"202d7dd2-1164-424e-98f5-69ab44721f8a","name":"推理API（数据面）","repoName":"qianfan-api","filePath":"模型/推理API（数据面）","disabled":false,"path":"xmwbl4528","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"Nmwbl45c6","documentId":"985bba32-c873-4e13-9148-0631067ca278","name":"在线推理","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理","disabled":false,"path":"Nmwbl45c6","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"Lmwbl4964","documentId":"238db9ce-a1e9-4ed4-a3d7-5138c285ae5a","name":"语音","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理/语音","disabled":false,"path":"Lmwbl4964","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"amwbl4cvl","documentId":"c4330d83-2370-4779-b2ce-65e3bb0b5c7f","name":"语音合成","repoName":"qianfan-api","filePath":"模型/推理API（数据面）/在线推理/语音/语音合成","disabled":false,"path":"amwbl4cvl","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}],"specificSeo":null}}}