You need to enable JavaScript to run this app.
导航

参数基本说明

最近更新时间2024.02.27 14:57:22

首次发布时间2021.12.20 14:44:12

请求参数
字段含义层级格式必需备注
app应用相关配置1dict
appid应用标识2string需要申请
token应用令牌2string目前未生效,填写默认值:default_token
cluster业务集群2stringvolcano_tts
user用户相关配置1dict
uid用户标识2string建议填写真实的uid,非必须,可以填写一个默认值
audio音频相关配置1dict
voice_type音色类型2string发音人参数列表
rate音频采样率2int默认为 24000
bits音频采样点位数2int默认为 16
bitratemp3格式时对应的码率2int默认为 160
encoding音频编码格式2stringwav / pcm / ogg_opus / mp3,默认为 pcm
注意:wav 不支持流式
compression_rateopus格式时编码压缩比2int[1, 20],默认为 1
speed_ratio语速2float[0.2,3],默认为1,通常保留一位小数即可
volume_ratio音量2float[0.1, 3],默认为1,通常保留一位小数即可
pitch_ratio音高2float[0.1, 3],默认为1,通常保留一位小数即可
emotion情感/风格2string发音人参数列表
language语言类型2string发音人参数列表
request请求相关配置1dict
reqid请求标识2string建议使用 UUID,每次合成时需要重新设置
text文本2string合成语音的文本,长度限制 1024 字节
text_type文本类型2stringplain / ssml, 默认为plain, SSML当前仅支持中文音色
silence_duration句尾静音时长2int单位为ms,不设置为125ms
operation操作2stringquery(非流式,http只能query) / submit(流式)
with_frontend时间戳相关2int
string
当with_frontend为1且frontend_type为unitTson的时候,返回音素级时间戳
frontend_type时间戳相关2int
string
当with_frontend为1且frontend_type为unitTson的时候,返回音素级时间戳
with_timestamp时间戳相关2int
string
新版时间戳参数,可用来替换with_frontend和frontend_type,可返回原文本的时间戳,而非TN后文本,即保留原文中的阿拉伯数字或者特殊符号等。注意:原文本中的多个标点连用或者空格依然会被处理,但不影响时间戳连贯性
split_sentence复刻音色语速优化2int
string
仅当使用复刻音色时设为1,可优化语速过快问题。会导致时间戳功能不连贯。详情可见:声音复刻录音指导-badcase优化建议2
pure_english_opt英文前端优化2int
string
当pure_english_opt为1的时候,对英文的音素识别优化

请求示例

{
    "app": {
        "appid": "appid123",
        "token": "access_token",
        "cluster": "volcano_tts",
    },
    "user": {
        "uid": "uid123"
    },
    "audio": {
        "voice_type": "BV700_streaming",
        "encoding": "mp3",
        "compression_rate": 1,
        "rate": 24000,
        "bits": 16,
        "channel": 1,
        "speed_ratio": 1.0,
        "volume_ratio": 1.0,
        "pitch_ratio": 1.0,
        "emotion": "happy",
        "language": "cn"
    },
    "request": {
        "reqid": "uuid",
        "text": "字节跳动语音合成",
        "text_type": "plain",
        "operation": "query",
        "silence_duration": "125",
        "with_frontend": "1",
        "frontend_type": "unitTson",
        "pure_english_opt": "1"
    }
}
返回参数
字段含义层级格式备注
reqid请求 ID1string请求 ID,与传入的参数中 reqid 一致
code请求状态码1int错误码,参考下方说明
message请求状态信息1string错误信息
sequence音频段序号1int负数表示合成完毕
data合成音频1string返回的音频数据,base64 编码
addition额外信息1string额外信息父节点
duration音频时长2string返回音频的长度,单位ms
frontend时间戳信息2string包含字级别和音素级别的时间戳信息

响应示例

{
	"reqid": "reqid",
	"code": 3000,
	"operation": "query",
	"message": "Success",
	"sequence": -1,
	"data": "base64 encoded binary data",
	"addition": {
		"description": "...",
		"duration": "1960",
		"frontend": "{
			"words": [{
				"word": "字",
				"start_time": 0.025,
				"end_time": 0.185
			},
			... 
			{
				"word": "。",
				"start_time": 1.85,
				"end_time": 1.955
			}],
			"phonemes": [{
				"phone": "C0z",
				"start_time": 0.025,
				"end_time": 0.105
			},
			... 
			{
				"phone": "。",
				"start_time": 1.85,
				"end_time": 1.955
			}]
		}"
	}
}
错误码说明
错误码错误描述举例
3000请求正确正常合成
3001无效的请求必填字段缺失,例如appid/cluster
3003并发超限超过在线设置的并发限制,例如申请2并发,超过的部分合成失败
3005后端服务忙后端服务器负载高,总并发超过集群可承载量
3006请求重复同一时刻相同reqid进行请求
3010文本长度超限单次请求超过最大可支持长度
3011无效文本英文音色传递了纯中文文本
3020无效的编码格式编码格式设置有误,encoding设置了非法值
3021无效的编码参数编码参数设置有误,rate设置<0
3022编码错误编码出现问题,出现概率低
3030处理超时单次请求超过服务最长时间限制,一般后端处理异常时出现
3031处理错误传递了一个不存在的音色名称,合成错误
3032服务内部网络异常后端实例间连接断开,出现概率低