智慧学习服务文档目录
帮助与文档 > 产品文档 > 智慧学习服务 > API文档 > 汉字拼音标注
汉字拼音标注

汉字拼音标注 API 简介

说明

Hi，您好，欢迎使用有道智云汉字拼音标注API接口服务。

本文档主要针对需要集成HTTP API的技术开发工程师，详细描述汉字拼音标注能力相关的技术内容。

如果您有与我们商务合作的需求，可以通过以下方式联系我们：

商务邮箱： AIcloud_Business@corp.youdao.com

如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：

客服QQ：1906538062

智云翻译技术交流QQ 1群: 652880659

智云翻译技术交流QQ 2群: 669384425

智云翻译技术交流QQ 3群: 807539209

智云翻译技术交流QQ 4群: 936752411

联系邮箱： zhiyun@corp.youdao.com

温馨提示：

  • 本文档主要针对开发人员，接入测试前需要获取 应用ID 和 应用密钥；如果您还没有，请按照新手指南 获取。
  • 平台向每个账户赠送50元的体验金，供用户集成前测试所用，具体资费规则详见 汉字拼音标注服务报价 。

接口说明

汉字拼音标注API接口提供有道的获取汉字拼音标注服务。

汉字拼音标注API HTTPS地址：

https://openapi.youdao.com/getPinYin

协议须知

调用方在集成网页翻译API时，请遵循以下规则。

规则 描述
传输方式 HTTPS
请求方式 POST
字符编码 统一使用UTF-8 编码
请求格式 表单
响应格式 JSON

接口调用参数

调用API需要向接口发送以下字段来访问服务。

字段名 类型 含义 必填 备注
q text 需要获取拼音的文本 True 必须是UTF-8编码
appKey text 应用ID True 可在应用管理 查看
salt text UUID True uuid，唯一通用识别码
sign text 签名 True sha256(应用ID+input+salt+curtime+应用密钥)
signType text 签名类型 True v3
curtime text 当前UTC时间戳(秒) true TimeStamp

签名生成方法如下： signType=v3； sign=sha256(应用ID+input+salt+curtime+应用密钥)； 其中，input的计算方式为：input=q前10个字符 + q长度 + q后10个字符（当q长度大于20）或 input=q字符串（当q长度小于等于20）；

注意：

  1. 接口salt+curtime来防重放（即一个请求不可以被请求2次），所以salt最好为UUID。

不同语言获取时间戳，请参看此链接

如果对签名有疑问，可以参看各语言demo。

输出结果

正常返回

字段名 含义
data 翻译结果
errorCode 错误码
errorMessage 成功信息

异常返回

字段名 含义
errorCode 错误码
errorMessage 错误信息

服务配置

单次查询最大字符数
200

错误代码列表

错误码 含义
101 缺少必填的参数,首先确保必填参数齐全，然后确认参数书写是否正确。
102 不支持的语言类型
103 翻译文本过长
104 不支持的API类型
105 不支持的签名类型
106 不支持的响应类型
107 不支持的传输加密类型
108 应用ID无效，注册账号，登录后台创建应用并完成绑定，可获得应用ID和应用密钥等信息
109 batchLog格式不正确
110 无相关服务的有效应用,应用没有绑定服务应用，可以新建服务应用。注：某些服务的翻译结果发音需要tts服务，需要在控制台创建语音合成服务绑定应用后方能使用。
111 开发者账号无效
112 请求服务无效
113 q不能为空
114 不支持的图片传输方式
116 strict字段取值无效，请参考文档填写正确参数值
201 解密失败，可能为DES,BASE64,URLDecode的错误
202 签名检验失败,如果确认应用ID和应用密钥的正确性，仍返回202，一般是编码问题。请确保翻译文本 q 为UTF-8编码.
203 访问IP地址不在可访问IP列表
205 请求的接口与应用的平台类型不一致，确保接入方式（Android SDK、IOS SDK、API）与创建的应用平台类型一致。如有疑问请参考入门指南
206 因为时间戳无效导致签名校验失败
207 重放请求
301 辞典查询失败
302 翻译查询失败
303 服务端的其它异常
304 会话闲置太久超时
401 账户已经欠费，请进行账户充值
402 offlinesdk不可用
405 鉴权失败
500 翻译失败，请参考errorMessage
411 访问频率受限,请稍后访问
412 长请求过于频繁，请稍后访问
1001 无效的OCR类型
1002 不支持的OCR image类型
1003 不支持的OCR Language类型
1004 识别图片过大
1201 图片base64解密失败
1301 OCR段落识别失败
1411 访问频率受限
1412 超过最大识别字节数
2003 不支持的语言识别Language类型
2004 合成字符过长
2005 不支持的音频文件类型
2006 不支持的发音类型
2201 解密失败
2301 服务的异常
2411 访问频率受限,请稍后访问
2412 超过最大请求字符数
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 服务调用失败

常用语言demo

Java 示例

汉字拼音标注 Java demo

python3 示例

汉字拼音标注 python3 demo

go 示例

汉字拼音标注 go demo

php 示例

汉字拼音标注 php demo

c# 示例

汉字拼音标注 c# demo