數(shù)字人在線交互簡介
概念解釋
數(shù)字人在線交互服務(wù),具備實(shí)時語音交互功能,能夠進(jìn)行即時在線對話,并擁有強(qiáng)大的學(xué)習(xí)能力。
說明
Hi,您好,歡迎使用有道智云數(shù)字人在線交互接口服務(wù)。
本文檔主要針對需要集成HTTP API的技術(shù)開發(fā)工程師,詳細(xì)描述數(shù)字人在線交互能力相關(guān)的技術(shù)內(nèi)容。
如果您有與我們商務(wù)合作的需求,可以通過以下方式聯(lián)系我們:
商務(wù)郵箱: AIcloud_Business@corp.youdao.com
如果您對文檔內(nèi)容有任何疑問,可以通過以下幾種方式聯(lián)系我們:
客服QQ:1906538062
AIGC產(chǎn)品技術(shù)交流群 :837394306
聯(lián)系郵箱: zhiyun@corp.youdao.com
溫馨提示:
- 本文檔主要針對開發(fā)人員,接入測試前需要獲取應(yīng)用ID和應(yīng)用密鑰,并創(chuàng)建應(yīng)用;如果您還沒有,請按照 新手指南 獲取。
- 平臺向每個賬戶贈送50元的體驗(yàn)金,供用戶集成前測試所用。
協(xié)議須知
調(diào)用方在集成數(shù)字人在線交互時,請遵循以下規(guī)則。
Content-Type: application/x-www-form-urlencoded
接入說明
交互數(shù)字人接入分為兩個部分。分別為“控制端”和視頻流“接收端”。
其中,控制端為api接口,負(fù)責(zé)控制數(shù)字人交互,開關(guān)數(shù)字人房間等功能。接收端為數(shù)字人視頻流播放端,負(fù)責(zé)實(shí)時接收并播放數(shù)字人視頻數(shù)據(jù)。
步驟:
1、接收端接入,如需參考示例請點(diǎn)擊demo參考示例:,請使用appkey:d5ecd0329d418cba4cadef3f58814db6
2、控制端接入,api文檔參考本文以下接口說明。開啟房間獲取房間號rid和房間token。
3、接收端填入步驟2返回的rid、token、uid即可接收數(shù)字人視頻流。
功能介紹
交互數(shù)字人控制api(接收端)
下載鏈接:
前端交互接收端demo:前端交互demo
請求地址
交互數(shù)字人控制api(控制端)
數(shù)字人在線交互線上調(diào)用地址:
<https://openapi.youdao.com/interactiveAiPerson/control>
數(shù)字人在線交互接口定義
1、接口說明:
1、交互數(shù)字人控制api
調(diào)用方法:
1、command發(fā)送start指令開通直播房間,獲取房間號rid
2、command發(fā)送push指令,向數(shù)字人發(fā)送對話文本
3、command發(fā)送interrupt指令,可以打斷數(shù)字人說話
4、command發(fā)送end指令,關(guān)閉數(shù)字人房間
注:超過10分鐘未發(fā)送指令的的房間會被自動關(guān)閉。
2、接口參數(shù):
字段名 | 含義 | 備注 | 必填 |
---|
appKey | 應(yīng)用標(biāo)識(應(yīng)用 ID) | true |
curtime | 當(dāng)前時間戳(秒) | true |
salt | 隨機(jī)字符串 | UUID | true |
sign | 簽名信息:sha256(appKey+salt+curtime+密鑰) | true |
signType | 簽名類型 | v4 | true |
command | 指令參數(shù),包括開關(guān)房間,推送文本等功能 | 支持取值:start、push、interrupt、end | true |
rid | 房間號 | push、interrupt、end等指令需要 | false |
text | 推送文本,發(fā)送給數(shù)字人做問答 | push指令需要。文本長度不超過200字符。 | false |
anchorId | 主播id | start指令需要,默認(rèn):nertc,目前僅支持nertc | false |
服務(wù)配置說明
- 服務(wù)接口統(tǒng)一設(shè)置 :Content-Type: application/x-www-form-urlencoded
注意:
簽名生成方法如下:
signType=v4;
sign=sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰);
3、返回結(jié)果:
參數(shù)名稱 | 描述 | 類型 |
---|
errorCode | 錯誤碼 | text |
msg | 描述 | text |
requestId | 請求id | text |
result | 結(jié)果 |
+rid | 房間id | text |
+token | 房間token | text |
+uid | 用戶id | bigint |
錯誤代碼列表
狀態(tài)碼 | 狀態(tài)碼含義 |
---|
101 | 缺少必填的參數(shù),首先確保必填參數(shù)齊全,然后,確認(rèn)參數(shù)書寫是否正確。 |
102 | 不支持的語言類型 |
103 | 翻譯文本過長 |
104 | 不支持的API類型 |
105 | 不支持的簽名類型 |
106 | 不支持的響應(yīng)類型 |
107 | 不支持的傳輸加密類型 |
108 | 應(yīng)用ID無效,注冊賬號,登錄后臺創(chuàng)建應(yīng)用并完成綁定,可獲得應(yīng)用ID和應(yīng)用密鑰等信息 |
109 | batchLog格式不正確 |
110 | 無相關(guān)服務(wù)的有效應(yīng)用,應(yīng)用沒有綁定服務(wù)。注:某些服務(wù)的結(jié)果發(fā)音需要tts服務(wù),需要在控制臺創(chuàng)建語音合成實(shí)例綁定應(yīng)用后方能使用。 |
111 | 開發(fā)者賬號無效 |
112 | 請求服務(wù)無效 |
113 | q不能為空 |
114 | 不支持的圖片傳輸方式 |
201 | 解密失敗,可能為DES,BASE64,URLDecode的錯誤 |
202 | 簽名檢驗(yàn)失敗,如果確認(rèn)應(yīng)用ID和應(yīng)用密鑰的正確性,仍返回202,一般是編碼問題。請確保翻譯文本 q 為UTF-8編碼. |
203 | 訪問IP地址不在可訪問IP列表 |
205 | 請求的接口與應(yīng)用的平臺類型不一致,確保接入方式(Android SDK、IOS SDK、API)與創(chuàng)建的應(yīng)用平臺類型一致。如有疑問請參考入門指南 |
206 | 因?yàn)闀r間戳無效導(dǎo)致簽名校驗(yàn)失敗 |
207 | 重放請求,接口salt+curtime來防重放(即一個請求不可以被請求2次 |
303 | 服務(wù)異常 |
405 | 鑒權(quán)失敗 |
IPP2001 | 不支持的command取值 |
IPP2002 | 房間ID錯誤 |
IPP2003 | 主播ID錯誤 |
IPP2004 | 通道已滿 |
IPP2005 | api請求失敗 |
IPP2006 | 房間啟動失敗 |
IPP2007 | command處理失敗 |