API文檔
IOS_SDK文檔
SDK隱私政策
漢字拼音標注
漢字拼音標注 API 簡介
說明
Hi，您好，歡迎使用有道智云漢字拼音標注API接口服務。
本文檔主要針對需要集成HTTP API的技術開發(fā)工程師，詳細描述漢字拼音標注能力相關的技術內容。
如果您有與我們商務合作的需求，可以通過以下方式聯系我們：
商務郵箱： AIcloud_Business@corp.youdao.com
如果您對文檔內容有任何疑問，可以通過以下幾種方式聯系我們：
客服QQ：1906538062
智云翻譯技術交流QQ 1群: 652880659
智云翻譯技術交流QQ 2群: 669384425
智云翻譯技術交流QQ 3群: 807539209
智云翻譯技術交流QQ 4群: 936752411
聯系郵箱： zhiyun@corp.youdao.com
溫馨提示：
- 本文檔主要針對開發(fā)人員，接入測試前需要獲取
應用ID和應用密鑰；如果您還沒有，請按照新手指南 獲取。 - 平臺向每個賬戶贈送50元的體驗金，供用戶集成前測試所用，具體資費規(guī)則詳見 漢字拼音標注服務報價 。
接口說明
漢字拼音標注API接口提供有道的獲取漢字拼音標注服務。
漢字拼音標注API HTTPS地址：
https://openapi.youdao.com/getPinYin
協議須知
調用方在集成網頁翻譯API時，請遵循以下規(guī)則。
| 規(guī)則 | 描述 |
|---|---|
| 傳輸方式 | HTTPS |
| 請求方式 | POST |
| 字符編碼 | 統一使用UTF-8 編碼 |
| 請求格式 | 表單 |
| 響應格式 | JSON |
接口調用參數
調用API需要向接口發(fā)送以下字段來訪問服務。
| 字段名 | 類型 | 含義 | 必填 | 備注 |
|---|---|---|---|---|
| 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）；
注意：
- 接口salt+curtime來防重放（即一個請求不可以被請求2次），所以salt最好為UUID。
不同語言獲取時間戳，請參看此鏈接
如果對簽名有疑問，可以參看各語言demo。
輸出結果
正常返回
| 字段名 | 含義 |
|---|---|
| data | 翻譯結果 |
| errorCode | 錯誤碼 |
| errorMessage | 成功信息 |
異常返回
| 字段名 | 含義 |
|---|---|
| errorCode | 錯誤碼 |
| errorMessage | 錯誤信息 |
服務配置
| 單次查詢最大字符數 |
|---|
| 200 |
錯誤代碼列表
| 錯誤碼 | 含義 |
|---|---|
| 101 | 缺少必填的參數,首先確保必填參數齊全，然后確認參數書寫是否正確。 |
| 102 | 不支持的語言類型 |
| 103 | 翻譯文本過長 |
| 104 | 不支持的API類型 |
| 105 | 不支持的簽名類型 |
| 106 | 不支持的響應類型 |
| 107 | 不支持的傳輸加密類型 |
| 108 | 應用ID無效，注冊賬號，登錄后臺創(chuàng)建應用并完成綁定，可獲得應用ID和應用密鑰等信息 |
| 109 | batchLog格式不正確 |
| 110 | 無相關服務的有效應用,應用沒有綁定服務應用，可以新建服務應用。注：某些服務的翻譯結果發(fā)音需要tts服務，需要在控制臺創(chuàng)建語音合成服務綁定應用后方能使用。 |
| 111 | 開發(fā)者賬號無效 |
| 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）與創(chuàng)建的應用平臺類型一致。如有疑問請參考入門指南 |
| 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 | 超過最大識別字節(jié)數 |
| 2003 | 不支持的語言識別Language類型 |
| 2004 | 合成字符過長 |
| 2005 | 不支持的音頻文件類型 |
| 2006 | 不支持的發(fā)音類型 |
| 2201 | 解密失敗 |
| 2301 | 服務的異常 |
| 2411 | 訪問頻率受限,請稍后訪問 |
| 2412 | 超過最大請求字符數 |
| 3001 | 不支持的語音格式 |
| 3002 | 不支持的語音采樣率 |
| 3003 | 不支持的語音聲道 |
| 3004 | 不支持的語音上傳類型 |
| 3005 | 不支持的語言類型 |
| 3006 | 不支持的識別類型 |
| 3007 | 識別音頻文件過大 |
| 3008 | 識別音頻時長過長 |
| 3009 | 不支持的音頻文件類型 |
| 3010 | 不支持的發(fā)音類型 |
| 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 | 服務調用失敗 |