API文檔
產品定價
語音合成模型調用
個性化音色調用
說明
Hi，您好，歡迎使用有道智云個性化語音調用接口服務。
本文檔主要針對需要集成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ā)人員，接入測試前需要在控制臺開通賬戶；如果您還沒有，請按照 新手指南 獲取。
- 接入時需要購買語音定制資源包或者聯系商務開通，供測試使用，可在平臺免費體驗。
接口說明
個性化語音調用服務，用戶可迅速使用自己定制的語音合成服務。
服務主要分模型定制和模型調用兩部分。
協議須知
調用方在集成個性化語音調用服務API時，請遵循以下規(guī)則。
| 規(guī)則 | 描述 |
|---|---|
| 傳輸方式 | HTTPS |
| 請求方式 | GET或POST |
| 字符編碼 | 統(tǒng)一使用UTF-8 編碼 |
| 請求格式 | 表單 |
| 響應格式 | JSON |
接口調用參數
個性化語音定制調用地址：
https://openapi.youdao.com
模型調用階段
調用TTS接口
接口uri：/ttsapi/tts/model
接口說明：
模型訓練成功以后，如果要合成的內容為文本，調用此接口。
接口參數：
| 參數名稱 | 類型 | 含義 | 是否必填 | 示例 |
|---|---|---|---|---|
| appKey | String | 應用ID | True | 可在 應用管理 查看 |
| salt | String | UUID（唯一識別通用碼） | True | UUID |
| curtime | String | 時間戳（秒） | True | 秒 |
| sign | String | 簽名 | True | sha256(應用ID+salt+curtime+應用密鑰) |
| signType | String | 簽名版本 | False | v4 (目前僅支持v4) |
| version | String | 接口版本 | False | v1 (目前僅支持v1) |
| docType | String | 服務器響應類型 | False | json (目前僅支持json) |
| modelId | String | 模型ID | True | M_CC164FF7040141CD88C96B59B90EC695 |
| q | String | 待合成的文本 （必須是UTF-8編碼，長度不超過1000字符，需要進行urlencode編碼） | True | 比如："您好" |
| format | String | 音頻格式(支持mp3,wav格式，默認mp3) | True | mp3或wav |
| rate | String | 合成音頻采樣率(支持8000, 16000, 44100。默認44100) | True | 16000 |
| speed | String | 語速（取值：0.5-2.0，默認1.0） | True | 1.0 |
| volume | String | 音量 （取值： 0.5-5.0，默認1.0） | True | 0.5 |
- 響應結果
需要根據Content-Type的值確定是否合成成功： 如果合成成功，正常返回為二進制語音文件，具體的header信息 Content-Type:audio/x-wav 如果合成失敗，會返回json結果，具體的header信息 Content-Type:application/json, 可以根據（模型錯誤碼）確定出現的問題。
調用VC接口
接口uri：/ttsapi/vc/model
接口說明：
模型訓練成功以后，如果要合成的內容為文本，調用此接口。
接口參數：
| 參數名稱 | 類型 | 含義 | 是否必填 | 示例 |
|---|---|---|---|---|
| appKey | String | 應用ID | True | 可在 應用管理 查看 |
| salt | String | UUID（唯一識別通用碼） | True | UUID |
| curtime | String | 時間戳（秒） | True | 秒 |
| sign | String | 簽名 | True | sha256(應用ID+salt+curtime+應用密鑰) |
| signType | String | 簽名版本 | False | v4 (目前僅支持v4) |
| version | String | 接口版本 | False | v1 (目前僅支持v1) |
| docType | String | 服務器響應類型 | False | json (目前僅支持json) |
| modelId | String | 模型ID | True | M_CC164FF7040141CD88C96B59B90EC695 |
| file | MultipartFile | 待合成的音頻文件 (2秒-120秒) | True | 音頻文件 |
- 響應結果
需要根據Content-Type的值確定是否合成成功： 如果合成成功，正常返回為二進制語音文件，具體的header信息 Content-Type:audio/x-wav 如果合成失敗，會返回json結果，具體的header信息 Content-Type:application/json, 可以根據（合成錯誤碼）確定出現的問題。
語音合成類型
| 類型 | 類型描述 |
|---|---|
| vc | 語音轉語音,輸入音頻,輸出定制化音色音頻 |
| tts | 文本轉語音,輸入文本,輸出定制化音色音頻 |
服務配置
| 輸出格式 | 單次最大請求字符數 | 單次最大請求時長 | 支持語言 |
|---|---|---|---|
| wav | 1000 | 2s - 2min | 中文 |
模型錯誤碼
| 錯誤碼 | 錯誤碼含義 |
|---|---|
| 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 | 不支持的圖片傳輸方式 |
| 115 | 語音包異常：不存在或者已刪除或者不屬于當前devId |
| 116 | modelId 無效 |
| 201 | 解密失敗，可能為DES,BASE64,URLDecode的錯誤 |
| 202 | 簽名檢驗失敗 |
| 203 | 訪問IP地址不在可訪問IP列表 |
| 205 | 請求的接口與應用的平臺類型不一致，確保接入方式（Android SDK、IOS SDK、API）與創(chuàng)建的應用平臺類型一致。 |
| 206 | 因為時間戳無效導致簽名校驗失敗 |
| 207 | 重放請求 |
| 303 | 服務端的其它異常 |
| 401 | 賬戶已經欠費停 |
| 402 | offlinesdk不可用 |
| 403 | 無權限 |
| 404 | 資源不存在 |
| 405 | auth服務不可用 |
| 117 | 鑒權失敗 |
| 110 | 無相關服務的有效實例 |
| 303 | 服務端異常 |
| 2004 | 合成字符過大 |
| 2301 | 合成失敗 |
| 2302 | 合成次數不足 |
| 2303 | 文件不能為空 |
| 2304 | 文件錯誤 |
| 2305 | 文件格式錯誤 |
| 2306 | modelId 無效 |
| 2307 | packetId 無效 |
| 2308 | 文件大小錯誤 |