接口文档
更新时间 2026-06-11 10:19:09
最近更新时间: 2026-06-11 10:19:09
接口信息
API Path
/aipaas/voice/v1/tts/supernaturalrt
请求协议
WS
建立连接时的请求参数(websocket open):
请求头部:
| 头部标签 | 必填 | 说明 | 类型 | 数据字典 | 限制 | 头部内容 | 示例 |
|---|---|---|---|---|---|---|---|
| Content-Type | 是 | application/json | [string] | - | - | application/json | application/json |
| X-APP-ID | 是 | 系统管理--API Key,创建应用获取AppID 和AppKey,公网鉴权,公网调用时必传 | [string] | - | - | - | - |
| Device-Uuid | 否 | 设备管理-设备uuid | [string] | - | - | - | - |
| Authorization | 是 | 鉴权信息 | [string] | - | - | - | - |
请求参数
Json Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| req_id | 请求全局唯一 ID,记录该值便于排查问题 | 是 | [string] | - | - | - |
| text | 待合成的文本,需要为 UTF-8 编码 | 是 | [string] | - | - | - |
| format | 音频编码格式,支持 PCM 格式,默认值:PCM | 否 | [string] | - | - | - |
| sample_rate | 音频采样率,支持 24000Hz、22050Hz、16000 Hz 和 8000 Hz,默认值:24000 | 否 | [int] | - | - | |
| voice | 说话⼈,支持音色 cixingnan、songchinan、surennan、cixingnan2、zhubonan、kefunan、zhuchinan、jilunan2、surennv、xianliaonv、mansunv、kefunv1、huoponv、ruyanv、xinwennv、kefunv2、luolinv、huoponv2、qingtiannv、cixingnan3、gaojinv、gushinan2、jilunan1、kejinan1、kejinan2、pingdannv、zhiyin、tuokouxiu、xuanyinan、sarah, 默认音色为 cixingnan | 否 | [string] | - | - | - |
| speech_rate | 语速,取值范围:[0.5, 2.0],默认值:1.0 | 否 | [float] | - | - | - |
| volume | 音量,取值范围:[0, 100],默认值:50 | 否 | [int] | - | - | - |
| 响应报文: | - | - | - | - | - | - |
返回结果
成功 (200) Json Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| status | 状态码,与code相同(注:2025年11⽉30⽇后不再返回此字段) | 是 | [int] | - | - | - |
| status_msg | 状态说明,与message相同(注:2025年11⽉30⽇后不再返回此字段) | 是 | [string] | - | - | - |
| code | 状态码,⻅服务码说明 | 是 | [int] | - | - | - |
| message | 状态说明,⻅服务码说明 | 是 | [string] | - | - | - |
| sid | 会话全局唯一 id,用于记录本次会话 | 是 | [string] | - | - | - |
| result | 合成结果 | 是 | [object] | - | - | - |
| result>>audio | 合成音频数据,经过 base64 编码 | 是 | [string] | - | - | - |
| result>>audio_len | 合成音频长度,单位:ms | 是 | [int] | - | - | - |
| result>>is_end | 标志位。true:最后一个合成片段;false:中间合成片段 | 是 | [boolean] | - | - | - |
能力简介
超自然流式语音合成提供将输入文本合成为语音二进制数据的功能。
支持输出格式:PCM 编码;
支持设置采样率:8000 Hz,16000 Hz, 22050Hz, 24000Hz;
⾳频为单声道,位深为 16 bit;
支持设置语速、音量;
支持设置多种说话人;
⽀持⼀次性合成 500 字符以内的文字,其中 1 个汉字、1 个英文字⺟、1 个标点或 1 个句⼦中间空格均算作 1 个字符,超过 500 个字符的内容将会截断,超过500字的文字不再进⾏合成;
仅支持采用 UTF-8 编码的文本输入;
服务鉴权
服务接口调用时需要严格遵循服务鉴权规则,服务调用鉴权规则请参见:开发指南 - 接口签名认证。
响应结果说明
握手返回结果
| 返回码 | 说明 | 错误信息 | 解决方法 |
|---|---|---|---|
| 101 | 成功 | {"message":"success"} | 成功,开始语音合成 |
| 4001 | 签名校验失败,授权失败 | {"message":"check sign fail"} | 联系商务,更新授权 |
| 4002 | 并发请求过多 | {"message":"Too many requests."} | 联系商务,增加并发 |
响应结果说明
开始合成响应示例
{
"code": 10000,
"message": "Success",
"sid": "4eHgiLCBhbGdvcml"
}接收合成数据响应示例
{
"code": 10000,
"message": "Success",
"result": {
"audio": "//6YYmNiDlSUXjZlDP8yADQAQ1E2ANKJOaTqFGUgIwDQAKAA==",
"audio_len": 2500,
"is_end": false
}
}合成结束响应示例
{
"code": 10000,
"message": "Success",
"result": {
"audio": "//6YYmNiDlSUXjZlDP8yADQAQ1E2ANKJOaTqFGUgIwDQAKAA==",
"audio_len": 2500,
"is_end": true
}
}请求示例
{
"req_id": "3a87fe9793c9-4ebd-95d4-4ce2-a80c054b",
"text": "今天是周⼀,天⽓挺好的。"
}状态码说明
| 状态码 | 解释 | 说明 | 解决方法 |
|---|---|---|---|
| 10301 | Parameter error | 参数错误 | 检查请求体是否符合接口协议 |
| 10302 | Too many requests | 并发请求过多 | 联系商务,增加并发 |
| 10304 | Parse request body fail | 请求格式错误 | 查看请求的 URL body 格式是否正确,参考接口文档 |
| 10503 | Server connection time out | 服务连接超时 | 联系技术人员 |
| 10903 | Synthesis failed | 合成失败 | 联系技术人员 |
| 10000 | Success | 成功 | 执行下一步操作 |