使用账号申请部分申请到的 appid&access_token 进行调用
文本一次性送入，后端边合成边返回音频数据

1. 接口说明

接口地址为 wss://openspeech.bytedance.com/api/v1/tts/ws_binary

2. 身份认证

认证方式使用 Bearer Token，在请求的 header 中加上"Authorization": "Bearer; {token}"，并在请求的 json 中填入对应的 appid。

AppID/Token/Cluster 等信息可参考 控制台使用FAQ-Q1

3. 请求方式

3.1 二进制协议

报文格式(Message format)

所有字段以 Big Endian(大端序) 的方式存储。
字段描述

消息类型详细说明

目前所有 TTS websocket 请求都使用 full client request 格式，无论"query"还是"submit"。

Full client request

• Header size为b0001(即 4B，没有 header extension)。
• Message type为b0001.
• Message type specific flags 固定为b0000.
• Message serialization method为b0001JSON。字段参考上方表格。
• 如果使用 gzip 压缩 payload，则 payload size 为压缩后的大小。

Audio-only server response

• Header size 应该为b0001.
• Message type为b1011.
• Message type specific flags 可能的值有：
  • b0000 - 没有 sequence number.
  • b0001 - sequence number > 0.
  • b0010orb0011 - sequence number < 0，表示来自服务器的最后一条消息，此时客户端应合并所有音频片段(如果有多条)。
• Message serialization method为b0000(raw bytes).

Demo

python

tts_websocket_demo.py

6.89KB

Java

tts-demo-java.zip

7.01KB

Go

tts_websocket_demo.go

7.68KB

使用账号申请部分申请到的 appid&access_token 进行调用
文本全部合成完毕之后，一次性返回全部的音频数据

1. 接口说明

接口地址为 https://openspeech.bytedance.com/api/v1/tts

2. 身份认证

认证方式采用 Bearer Token.
1)需要在请求的 Header 中填入"Authorization":"Bearer;${token}"

AppID/Token/Cluster 等信息可参考 控制台使用FAQ-Q1

3. 注意事项

• 使用 HTTP Post 方式进行请求，返回的结果为 JSON 格式，需要进行解析
• 因 json 格式无法直接携带二进制音频，音频经 base64 编码。使用 base64 解码后，即为二进制音频
• 每次合成时 reqid 这个参数需要重新设置，且要保证唯一性（建议使用 UUID/GUID 等生成）

Websocket 与 Http 调用参数相同

请求参数

备注：

1. 暂时不支持时间戳能力
2. ssml 能力已支持，详见 SSML 标记语言--语音技术-火山引擎 (volcengine.com)
3. 暂时不支持音高，音量调节
4. 大模型音色语种支持中英混

请求示例：

{
    "app": {
        "appid": "appid123",
        "token": "access_token",
        "cluster": "volcano_tts",
    },
    "user": {
        "uid": "uid123"
    },
    "audio": {
        "voice_type": "zh_male_M392_conversation_wvae_bigtts",
        "encoding": "mp3",
        "speed_ratio": 1.0,
    },
    "request": {
        "reqid": "uuid",
        "text": "字节跳动语音合成",
        "operation": "query",
    }
}

返回参数

响应示例

{
        "reqid": "reqid",
        "code": 3000,
        "operation": "query",
        "message": "Success",
        "sequence": -1,
        "data": "base64 encoded binary data",
        "addition": {
                "duration": "1960",
        }
}

注意事项

• websocket 单条链接仅支持单次合成，若需要合成多次，则需要多次建立链接
• 每次合成时 reqid 这个参数需要重新设置，且要保证唯一性（建议使用 uuid.V4 生成）
• operation 需要设置为 submit

1. 错误返回：
   "message": "quota exceeded for types: xxxxxxxxx_lifetime"
   错误原因：试用版用量用完了，需要开通正式版才能继续使用
2. 错误返回：
   "message": "quota exceeded for types: concurrency"
   错误原因：并发超过了限定值，需要减少并发调用情况或者增购并发
3. 错误返回：
   "message": "Fail to feed text, reason Init Engine Instance failed"
   错误原因：voice_type / cluster 传递错误
4. 错误返回：
   "message": "illegal input text!"
   错误原因：传入的 text 无效，没有可合成的有效文本。比如全部是标点符号或者 emoji 表情，或者使用中文音色时，传递日语，以此类推。多语种音色，也需要使用 language 指定对应的语种
5. 错误返回：
   "message": "authenticate request: load grant: requested grant not found"
   错误原因：鉴权失败，需要检查 appid&token 的值是否设置正确，同时，鉴权的正确格式为
   headers["Authorization"] = "Bearer;${token}"
6. 错误返回：
   "message': 'extract request resource id: get resource id: access denied"
   错误原因：语音合成已开通正式版且未拥有当前音色授权，需要在控制台购买该音色才能调用。标注免费的音色除 BV001_streaming 及 BV002_streaming 外，需要在控制台进行下单（支付 0 元）