API文档
常见问题
有道词典
有道词典 API 简介
服务使用
有道词典服务旨在将有道词典APP中的精华词汇内容以接口形式输出给有需要的的客户，您可以将需要查询的词汇及对应的词典发给此服务，我们将会通过接口为您返回释义、发音、音标、例句等结果信息。此服务暂不支持您在控制台自助开通，您可以在工作日10:00-18:00之间电话联系（010-8255-8901）智云获得接入支持，或者通过邮件（AIcloud_Business@corp.youdao.com）留下您的联系方式与合作需求，我们将在最近的工作日与您联系。
使用此服务您需要严格遵守有道智云服务条款 ,我们返回给您的数据严禁缓存、再利用与转卖，我们将通过技术手段巡查您是否有缓存数据等违规行为，若存在违规行为您需要承担相应的法律责任。
接口说明
有道词典接口输出汉语词典、中英词典、英中词典、英英词典、中韩词典、韩中词典、中日词典、日中词典的内容。
有道词典API HTTPS地址：
https://openapi.youdao.com/v2/dict
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 | 类型 | 含义 | 必填 | 备注 |
|---|---|---|---|---|
| q | text | 待查询的词 | True | 必须是UTF-8编码 |
| langType | text | 输入的语言，支持的语言参见语言列表 | True | auto |
| appKey | text | 创建api类型的应用获得的应用ID | True | testKey |
| dicts | text | 词典名 | True | dicts=ce dicts=ec |
| salt | text | 随机值，建议使用UUID，确保唯一性 | True | uuid，唯一通用识别码 |
| sign | text | 签名，sign由客户端算好后传递，具体生成规则，见附注 | True | whatever |
| signType | text | 签名类型 | True | v3 |
| curtime | text | 当前UTC时间戳(秒) | True | timestamp：1543199847 |
| docType | text | 服务器响应类型，目前只支持json | false | json |
签名生成方法如下：
signType=v3；
sign=sha256(应用ID+input+salt+curtime+应用密钥)；
其中，input的计算方式为：input=q前10个字符+q长度+q后10个字符（当q长度大于20）或input=q字符串（当q长度小于等于20）；
输出结果
| 字段名 | 类型 | 说明 |
|---|---|---|
| errorCode | String | 状态码 |
| result | JSONArray | 结果 |
| jc/kc/ec | JSONObject | 词典名称 |
| basic | JSONObject | 简明释义 |
| phonetic | text | 词典音标 |
| usPhonetic | text | 美式音标 |
| ukPhonetic | text | 英式音标 |
| ukSpeech | text | 英式发音 |
| usSpeech | text | 美式发音 |
| explains | text | 基本释义 |
| text | text | 短语 |
| explain | String Array | 词义解释列表 |
| wordFormats | Object Array | 单词形式变化列表 |
| name | String | 形式名称，例如：复数 |
| web | JSONArray | 网络释义 |
| phrase | String | 词组 |
| meaning | String | 含义 |
| synonyms | JSONObject | 近义词 |
| pos | String | 词性 |
| words | String Array | 近义词列表 |
| trans | String | 释义 |
| antonyms | ObjectArray | 反义词 |
| relatedWords | JSONArray | 相关词 |
| wordNet | JSONObject | 汉语词典网络释义 |
| phonetic | String | 发音 |
| meanings | ObjectArray | 释义 |
| meaning | String | 释义 |
| example | array | 示例 |
| dict | String | 词典deeplink |
| webDict | String | 词典网页deeplink |
| sentenceSample | text | 例句 |
| sentence | text | 例句 |
| sentenceBold | text | 将查询内容加粗的例句 |
| translation | text | 例句翻译 |
| wfs | text | 单词形式变化 |
| exam_type | text | 考试类型 |
示例
更多不同语言示例请参考有道词典示例
支持语言
下表为各语言对应代码：
| 语言 | 代码 |
|---|---|
| 自动识别 | auto |
| 中文 | zh-CHS |
| 英文 | en |
| 日文 | ja |
| 韩文 | ko |
支持的词典
| 语言 | 代码 | 语言参数 |
|---|---|---|
| 汉语词典 | yw | zh-CHS |
| 英英词典 | ee | en |
| 汉英词典 | ce | zh-CHS |
| 英汉词典 | ec | en |
| 日中词典 | jc | ja |
| 中日词典 | cj | zh-CHS |
| 韩中词典 | kc | ko |
| 中韩词典 | ck | zh-CHS |
错误代码列表
| 错误码 | 含义 |
|---|---|
| 101 | 缺少必填的参数,首先确保必填参数齐全，然后确认参数书写是否正确。 |
| 102 | 不支持的语言类型 |
| 103 | 翻译文本过长 |
| 104 | 不支持的API类型 |
| 105 | 不支持的签名类型 |
| 106 | 不支持的响应类型 |
| 107 | 不支持的传输加密类型 |
| 108 | 应用ID无效，注册账号，登录后台创建应用和实例并完成绑定，可获得应用ID和应用密钥等信息 |
| 109 | batchLog格式不正确 |
| 110 | 无相关服务的有效应用,应用没有创建，可以新建服务。注：某些服务的翻译结果发音需要tts服务，需要在控制台创建语音合成应用后方能使用。 |
| 111 | 开发者账号无效 |
| 113 | q不能为空 |
| 120 | 不是词，或未收录 |
| 201 | 解密失败，可能为DES,BASE64,URLDecode的错误 |
| 202 | 签名检验失败，请检查签名计算 |
| 203 | 访问IP地址不在可访问IP列表 |
| 205 | 请求的接口与应用的平台类型不一致，确保接入方式（Android SDK、IOS SDK、API）与创建的应用平台类型一致。如有疑问请参考入门指南 |
| 206 | 因为时间戳无效导致签名校验失败，请检查是否为当前UTC时间戳(秒) |
| 207 | 重放请求，salt和curetime防止接口被多次请求，请检查参数设置 |
| 301 | 词典查询失败 |
| 302 | 翻译查询失败 |
| 303 | 服务端的其它异常 |
| 305 | 批量翻译部分成功 |
| 401 | 账户已经欠费，请进行账户充值 |
| 411 | 访问频率受限,请稍后访问 |
| 412 | 长请求过于频繁，请稍后访问 |
| 390001 | 词典名称不正确，请检查输入内容与使用的词典是否匹配 |