文档中心
数字人 PaaS 服务
服务端 API
流式语音合成
创建流式语音合成任务

创建流式语音合成任务

更新时间：2024-07-30 10:28

描述

调用本接口通过配置声音参数，创建一个实时流式输出的语音合成任务。

接口原型

请求方法：POST
中国大陆正式环境请求地址：https://aigc-api.zegotech.cn/?Action=StreamTts
传输协议：HTTPS
调用频率限制：10 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数，公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
TimbreId	String	是	音色 ID，可通过查询音色列表获取。
Text	String	是	文本内容，不超过 300 个字。支持 SSML标记语言。
SpeechRate	Int	否	语速，取值范围为 [-500, 500]，默认值 0。数值越大，声音越快。
PitchRate	Int	否	语调，取值范围为 [-500, 500]，默认值 0。数值越大，声音越尖。
Volume	Int	否	音量，取值范围为 [1, 100]，默认值 50。数值越大，声音越大。

请求示例

请求 URL

https://aigc-api.zegotech.cn/?Action=StreamTts
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0

请求消息体

{
    "TimbreId": "your_timebre_id",
    "Text": "时维九月，序属三秋。潦水尽而寒潭清，烟光凝而暮山紫。俨骖騑于上路，访风景于崇阿。临帝子之长洲，得天人之旧馆。层峦耸翠，上出重霄；飞阁流丹，下临无地。鹤汀凫渚，穷岛屿之萦回；桂殿兰宫，即冈峦之体势。",
    "SpeechRate": 0,
    "PitchRate": 0,
    "Volume": 50
}

响应参数

请求成功

此时响应参数的 Content-Type 为 text/event-stream。响应参数为流式返回，格式为 data: {以下响应参数的 json 包}。

参数	类型	描述
TaskId	String	本次任务 ID。
Data	String	音频数据（WAV 格式），经过 base64 处理，开发者可以根据业务需求自行处理。
IsEnd	Bool	表示当前音频数据返回是否结束，false：未结束，true：结束。

请求失败

此时响应参数的 Content-Type 为 application/json，说明如下：

参数	类型	描述
Code	Int	返回码。
Message	String	操作结果描述。

响应示例

请求成功的响应示例：

data: {"TaskId":"fde20f93-57d6-4ed2-9d71-c258b1da97c4","Data":"UklGRr///39XQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YZv//38tAAEA3f/o//f/CwAHAP7/6P/o/wIAEAAJAPj/7v/4/wgADQAHAPr/7//5/w8AFQD4//P////+/xUAJwAkAA4A8v/M//z/OAAnAA8AGgAIAOL/BAAgACUALgANAAAAIgAjAAwAIQApAO3/z/8AADAAUgA7ABQA2f+9/9z/IwAmAEEAMA==","IsEnd":false}

data: {"TaskId":"fde20f93-57d6-4ed2-9d71-c258b1da97c4","Data":"","IsEnd":true}

请求失败的响应示例：

{
    "Code": 400000013,
    "Message": "stream tts error"
}

返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
0	成功。	-
100000004	签名过期。	请重新生成签名。
100000005	签名错误。	请确认生成签名的参数是否正确。
400000001	输入参数无效。	请根据 Message 提示，调整对应参数的取值。
400000002	数字人 PaaS 服务权限未开通。	请联系 ZEGO 技术支持开通服务权限。
400000004	未找到音色。	请确认设置的 TimbreId 是否正确。
400000013	流式 TTS 错误。	请联系 ZEGO 技术支持处理。
400000014	音色资源错误。	请联系 ZEGO 技术支持处理。
400010000	系统错误。	请联系 ZEGO 技术支持处理。
400010001	未获得接口调用权限。	请联系 ZEGO 技术支持开通服务权限。