API文档
							
							
								产品定价
							
							语音合成:将文字转语音的服务,可根据设置参数设置合成多国多音色语音,发音自然流畅。
Hi,您好,欢迎使用有道智云语音合成API接口服务。有道智云TTS API接口提供有道的文字转语音服务,您可以请求一段您想转换成语音的文字,就可以得到相应的文字转换而成的可播放的mp3音频。
如果您想快速体验服务,建议您前往 语音合成体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
本文档主要针对需要集成API的技术开发工程师,详细描述语音合成能力相关的技术内容。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云语音技术交流QQ群:861723255
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要获取应用ID和应用密钥;如果您还没有,请按照 新手指南操作 。
平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 语音合成服务报价 。
注:文字的UTF-8编码长度不能超过2048.
有道智云TTS API HTTPS地址:
https://openapi.youdao.com/ttsapi
调用方在集成语音合成API时,请遵循以下规则。
| 规则 | 描述 | 
|---|---|
| 传输方式 | HTTPS | 
| 字符编码 | 统一使用UTF-8编码 | 
| 请求方式 | POST | 
| 请求格式 | 表单 | 
| 响应格式 | JSON | 
调用API需要向接口发送以下字段来访问服务。
| 字段名 | 类型 | 含义 | 必填 | 备注 | 
|---|---|---|---|---|
| q | text | 待合成音频文件的文本字符串 | True | 比如:您好(文字的UTF-8编码长度不能超过2048.) | 
| appKey | text | 应用 ID | True | 可在 应用管理 查看 | 
| salt | text | UUID | True | UUID,唯一通用识别码,可在线生成 | 
| sign | text | 签名 | True | sha256(应用ID+input+salt+curtime+应用密钥) | 
| signType | text | 签名类型 | True | v3 | 
| curtime | text | 时间戳(秒) | true | 秒数 | 
| format | text | 目标音频格式,支持mp3 | false | mp3 | 
| speed | text | 合成音频的语速 | false | 比如:"1"为正常速度;最大为“2.0”,最小为“0.5” | 
| volume | text | 合成音频的音量 | false | 正常为"1.00",最大为"5.00",最小为"0.50" | 
| voiceName | text | 发言人名字 | true | 比如:youxiaoqin | 
签名生成方法如下: signType=v3; sign=sha256(
应用ID+input+salt+curtime+应用密钥); 其中,input的计算方式为:input=q前10个字符+q长度+q后10个字符(当q长度大于20)或input=q字符串(当q长度小于等于20);
注意:
应用ID+q+salt+应用密钥 字符串时,q 不需要做 URL encode,在生成签名之后,发送 HTTP 请求之前才需要对要发送的文本字段 q 做URL encode。** 需要根据Content-Type的值来确定合成是否成功 **
如果合成成功,正常返回为二进制语音文件,具体header信息 Content-type: audio/mp3;
如果合成出现错误,则会返回json结果,具体header信息为:Content-type: application/json。可以根据errorCode确定出现的问题(错误代码列表)。
{"errorCode":202}
| 中文名称 | 调用参数 | 音色 | 语种 | 计费分类 | 
|---|---|---|---|---|
| 有小智 | youxiaozhi | 男 | 中文 | 常见语种 | 
| 有小薰 | youxiaoxun | 女 | 中文 | 常见语种 | 
| 有小沁 | youxiaoqin | 女 | 中文 | 常见语种 | 
| 有小芙 | youxiaofu | 女 | 中文 | 常见语种 | 
| 有雨婷 | youyuting | 女 | 中文 | 常见语种 | 
| 有小浩 | youxiaohao | 男 | 中文 | 常见语种 | 
| 有小楠 | youxiaonan | 男 | 中文 | 常见语种 | 
| 有小课 | youxiaoke | 男 | 中文(支持讲题、公示朗读场景) | 常见语种 | 
| 有小美 | youxiaomei | 女 | 英文\美式 | 常见语种 | 
| 有小英 | youxiaoying | 女 | 英文\英式 | 常见语种 | 
| 有小伟 | youxiaowei | 男 | 英文\中文(混合) | 常见语种 | 
| 有小官 | youxiaoguan | 男 | 英文\英式 | 常见语种 | 
| 有雅婷 | youyating | 女 | 英文\美式 | 常见语种 | 
| Saila | Saila | 女 | 英文\英式 | 常见语种 | 
| Auriana | Auriana | 女 | 英文\英式 | 常见语种 | 
| 有可酱 | youkejiang | 女 | 日文 | 常见语种 | 
| 原田君 | yuantianjun | 男 | 日文 | 常见语种 | 
| 宫崎帅 | gongqishuai | 男 | 日文 | 非常见语种 | 
| 有小贝 | youxiaobei | 女 | 中文 | 常见语种 | 
| 有小道 | youxiaodao | 女 | 英文\美式 | 常见语种 | 
| 薇小美 | weixiaomei | 女 | 英文\美式 | 非常见语种 | 
| 薇小英 | weixiaoying | 男 | 英文\英式 | 非常见语种 | 
| 有梅梅 | youmeimei | 女 | 英文(词典发音) | 常见语种 | 
| 有莹莹 | youyingying | 女 | 英文(词典发音) | 常见语种 | 
| 有小绍 | youxiaoshao | 女 | 中英混(词典发音) | 常见语种 | 
| 朴智幼 | piaozhiyou | 女 | 韩文 | 常见语种 | 
| 朴泰言 | piaotaiyan | 男 | 韩文 | 常见语种 | 
| 安娜 | anna | 女 | 葡语 | 非常见语种 | 
| 薇粤粤 | weiyueyue | 女 | 粤语 | 非常见语种 | 
| 艾米娜 | aimina | 女 | 阿拉伯 | 非常见语种 | 
| 阿西亚 | axiya | 男 | 阿拉伯 | 非常见语种 | 
| 薇加泰 | weijiatai | 男 | 加泰隆 | 非常见语种 | 
| 薇小加 | weixiaojia | 女 | 加泰隆 | 非常见语种 | 
| Alois | Alois | 男 | 捷克 | 非常见语种 | 
| Bara | bara | 女 | 丹麦 | 非常见语种 | 
| Molly | Molly | 女 | 荷兰 | 非常见语种 | 
| William | William | 男 | 英语(澳大利亚) | 非常见语种 | 
| Olivia | Olivia | 女 | 英语(澳大利亚) | 非常见语种 | 
| neale | neale | 女 | 英语(英国) | 非常见语种 | 
| Osric | Osric | 男 | 英语(印度) | 非常见语种 | 
| Rama | Rama | 女 | 英语(印度) | 非常见语种 | 
| Noah | Noah | 男 | 英语(美国) | 非常见语种 | 
| 芬小美 | fenxiaomei | 女 | 芬兰语 | 非常见语种 | 
| 芬小帅 | fenxiaoshuai | 男 | 芬兰语 | 非常见语种 | 
| 法小美 | faxiaomei | 女 | 法语 | 非常见语种 | 
| 法小帅 | faxiaoshuai | 男 | 法语 | 非常见语种 | 
| 法大拿 | fadana | 女 | 法语(加拿大) | 非常见语种 | 
| 德小美 | dexiaomei | 女 | 德语 | 非常见语种 | 
| 德小帅 | dexiaoshuai | 男 | 德语 | 非常见语种 | 
| 希小帅 | xixiaoshuai | 男 | 希腊语 | 非常见语种 | 
| 希伯小帅 | xiboxiaoshuai | 男 | 希伯来语 | 非常见语种 | 
| 印地小帅 | yindixiaoshuai | 男 | 印地语 | 非常见语种 | 
| 印地小美 | yindixiaomei | 女 | 印地语 | 非常见语种 | 
| 匈小帅 | xiongxiaoshuai | 男 | 匈牙利语 | 非常见语种 | 
| 意小帅 | yixiaoshuai | 男 | 意大利语 | 非常见语种 | 
| 意小美 | yixiaomei | 女 | 意大利语 | 非常见语种 | 
| 俄小美 | exiaomei | 女 | 俄语 | 非常见语种 | 
| 俄小帅 | exiaoshuai | 男 | 俄语 | 非常见语种 | 
| 西小美 | xixiaomei | 女 | 西班牙语 | 非常见语种 | 
| 埃德加 | Edgar | 男 | 西班牙语 | 非常见语种 | 
| 薇小越 | weixiaoyue | 女 | 越南语 | 非常见语种 | 
| 薇小南 | weixiaonan | 男 | 越南语 | 非常见语种 | 
注意: 更多中文音色发音人列表请查看发音人列表
多音字示例:
<phoneme alphabet="sapi" ph="se 4">色</phoneme>彩
| 每小时最大查询次数 | 
|---|
| 3000 | 
| 错误码 | 含义 | 
|---|---|
| 101 | 缺少必填的参数,首先确保必填参数齐全,然后,确认参数书写是否正确。 | 
| 102 | 不支持的语言类型 | 
| 103 | 翻译文本过长 | 
| 104 | 不支持的API类型 | 
| 105 | 不支持的签名类型 | 
| 106 | 不支持的响应类型 | 
| 107 | 不支持的传输加密类型 | 
| 108 | 应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息 | 
| 109 | batchLog格式不正确 | 
| 110 | 无相关服务的有效实例,应用没有绑定服务,可以新建服务绑定服务。注:某些服务的结果发音需要tts服务,需要在控制台创建语音合成应用后方能使用。 | 
| 111 | 开发者账号无效 | 
| 112 | 请求服务无效 | 
| 113 | q不能为空 | 
| 114 | 不支持的图片传输方式 | 
| 201 | 解密失败,可能为DES,BASE64,URLDecode的错误 | 
| 202 | 签名检验失败 | 
| 203 | 访问IP地址不在可访问IP列表 | 
| 205 | 请求的接口与应用的平台类型不一致,确保接入方式(Android SDK、IOS SDK、API)与创建的应用平台类型一致。如有疑问请参考入门指南 | 
| 206 | 因为时间戳无效导致签名校验失败 | 
| 207 | 重放请求(接口salt+curtime来防重放(即一个请求不可以被请求2次),salt最好为UUID。) | 
| 301 | 辞典查询失败 | 
| 302 | 翻译查询失败 | 
| 303 | 服务端的其它异常 | 
| 304 | 会话闲置太久超时 | 
| 401 | 账户已经欠费停 | 
| 402 | offlinesdk不可用 | 
| 411 | 访问频率受限,请稍后访问 | 
| 412 | 长请求过于频繁,请稍后访问 | 
| 1001 | 无效的OCR类型 | 
| 1002 | 不支持的OCR image类型 | 
| 1003 | 不支持的OCR Language类型 | 
| 1004 | 识别图片过大 | 
| 1201 | 图片base64解密失败 | 
| 1301 | OCR段落识别失败 | 
| 1411 | 访问频率受限 | 
| 1412 | 超过最大识别字节数 | 
| 2003 | 不支持的语言识别Language类型 | 
| 2004 | 合成字符过长 | 
| 2005 | 不支持的音频文件类型 | 
| 2006 | 不支持的发音类型 | 
| 2008 | 不支持的语速范围 | 
| 2009 | 服务权限异常 | 
| 2011 | 合成音频语速不在参数范围内 | 
| 2013 | voiceName参数错误 | 
| 2201 | 解密失败 | 
| 2301 | 服务的异常 | 
| 2411 | 访问频率受限,请稍后访问 | 
| 2412 | 超过最大请求字符数 | 
| 2413 | 包含不合时宜词汇 | 
| 3001 | 不支持的语音格式 | 
| 3002 | 不支持的语音采样率 | 
| 3003 | 不支持的语音声道 | 
| 3004 | 不支持的语音上传类型 | 
| 3005 | 不支持的语言类型 | 
| 3006 | 不支持的识别类型 | 
| 3007 | 识别音频文件过大 | 
| 3008 | 识别音频时长过长 | 
| 3009 | 不支持的音频文件类型 | 
| 3010 | 不支持的发音类型 | 
| 3201 | 解密失败 | 
| 3301 | 语音识别失败 | 
| 3302 | 语音翻译失败 | 
| 3303 | 服务的异常 | 
| 3411 | 访问频率受限,请稍后访问 | 
| 3412 | 超过最大请求字符数 | 
| 4001 | 不支持的语音识别格式 | 
| 4002 | 不支持的语音识别采样率 | 
| 4003 | 不支持的语音识别声道 | 
| 4004 | 不支持的语音上传类型 | 
| 4005 | 不支持的语言类型 | 
| 4006 | 识别音频文件过大 | 
| 4007 | 识别音频时长过长 | 
| 4201 | 解密失败 | 
| 4301 | 语音识别失败 | 
| 4303 | 服务的异常 | 
| 4411 | 访问频率受限,请稍后访问 | 
| 4412 | 超过最大请求时长 | 
| 5001 | 无效的OCR类型 | 
| 5002 | 不支持的OCR image类型 | 
| 5003 | 不支持的语言类型 | 
| 5004 | 识别图片过大 | 
| 5005 | 不支持的图片类型 | 
| 5006 | 文件为空 | 
| 5201 | 解密错误,图片base64解密失败 | 
| 5301 | OCR段落识别失败 | 
| 5411 | 访问频率受限 | 
| 5412 | 超过最大识别流量 | 
| 9001 | 不支持的语音格式 | 
| 9002 | 不支持的语音采样率 | 
| 9003 | 不支持的语音声道 | 
| 9004 | 不支持的语音上传类型 | 
| 9005 | 不支持的语音识别 Language类型 | 
| 9301 | ASR识别失败 | 
| 9303 | 服务器内部错误 | 
| 9411 | 访问频率受限(超过最大调用次数) | 
| 9412 | 超过最大处理语音长度 | 
| 10001 | 无效的OCR类型 | 
| 10002 | 不支持的OCR image类型 | 
| 10004 | 识别图片过大 | 
| 10201 | 图片base64解密失败 | 
| 10301 | OCR段落识别失败 | 
| 10411 | 访问频率受限 | 
| 10412 | 超过最大识别流量 | 
| 11001 | 不支持的语音识别格式 | 
| 11002 | 不支持的语音识别采样率 | 
| 11003 | 不支持的语音识别声道 | 
| 11004 | 不支持的语音上传类型 | 
| 11005 | 不支持的语言类型 | 
| 11006 | 识别音频文件过大 | 
| 11007 | 识别音频时长过长,最大支持30s | 
| 11201 | 解密失败 | 
| 11301 | 语音识别失败 | 
| 11303 | 服务的异常 | 
| 11411 | 访问频率受限,请稍后访问 | 
| 11412 | 超过最大请求时长 | 
| 12001 | 图片尺寸过大 | 
| 12002 | 图片base64解密失败 | 
| 12003 | 引擎服务器返回错误 | 
| 12004 | 图片为空 | 
| 12005 | 不支持的识别图片类型 | 
| 12006 | 图片无匹配结果 | 
| 13001 | 不支持的角度类型 | 
| 13002 | 不支持的文件类型 | 
| 13003 | 表格识别图片过大 | 
| 13004 | 文件为空 | 
| 13301 | 表格识别失败 | 
| 15001 | 需要图片 | 
| 15002 | 图片过大(1M) | 
| 15003 | 服务调用失败 | 
| 17001 | 需要图片 | 
| 17002 | 图片过大(1M) | 
| 17003 | 识别类型未找到 | 
| 17004 | 不支持的识别类型 | 
| 17005 | 服务调用失败 |