数字人在线交互服务,具备实时语音交互功能,能够进行即时在线对话,并拥有强大的学习能力。
Hi,您好,欢迎使用有道智云数字人在线交互接口服务。
本文档主要针对需要集成HTTP API的技术开发工程师,详细描述数字人在线交互能力相关的技术内容。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
AIGC产品技术交流群 :837394306
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
调用方在集成数字人在线交互时,请遵循以下规则。
Content-Type: application/x-www-form-urlencoded
交互数字人接入分为两个部分。分别为“控制端”和视频流“接收端”。
其中,控制端为api接口,负责控制数字人交互,开关数字人房间等功能。接收端为数字人视频流播放端,负责实时接收并播放数字人视频数据。
步骤:
1、接收端接入,如需参考示例请点击demo参考示例:,请使用appkey:d5ecd0329d418cba4cadef3f58814db6
2、控制端接入,api文档参考本文以下接口说明。开启房间获取房间号rid和房间token。
3、接收端填入步骤2返回的rid、token、uid即可接收数字人视频流。
交互数字人控制api(接收端)
下载链接:
前端交互接收端demo:前端交互demo
交互数字人控制api(控制端)
数字人在线交互线上调用地址:
<https://openapi.youdao.com/interactiveAiPerson/control>
1、交互数字人控制api
调用方法:
1、command发送start指令开通直播房间,获取房间号rid
2、command发送push指令,向数字人发送对话文本
3、command发送interrupt指令,可以打断数字人说话
4、command发送end指令,关闭数字人房间
注:超过10分钟未发送指令的的房间会被自动关闭。
字段名 | 含义 | 备注 | 必填 |
---|---|---|---|
appKey | 应用标识(应用 ID) | true | |
curtime | 当前时间戳(秒) | true | |
salt | 随机字符串 | UUID | true |
sign | 签名信息:sha256(appKey+salt+curtime+密钥) | true | |
signType | 签名类型 | v4 | true |
command | 指令参数,包括开关房间,推送文本等功能 | 支持取值:start、push、interrupt、end | true |
rid | 房间号 | push、interrupt、end等指令需要 | false |
text | 推送文本,发送给数字人做问答 | push指令需要。文本长度不超过200字符。 | false |
anchorId | 主播id | start指令需要,默认:nertc,目前仅支持nertc | false |
注意:
签名生成方法如下:
signType=v4;
sign=sha256(应用ID+salt+curtime+应用密钥);
参数名称 | 描述 | 类型 |
---|---|---|
errorCode | 错误码 | text |
msg | 描述 | text |
requestId | 请求id | text |
result | 结果 | |
+rid | 房间id | text |
+token | 房间token | text |
+uid | 用户id | bigint |
状态码 | 状态码含义 |
---|---|
101 | 缺少必填的参数,首先确保必填参数齐全,然后,确认参数书写是否正确。 |
102 | 不支持的语言类型 |
103 | 翻译文本过长 |
104 | 不支持的API类型 |
105 | 不支持的签名类型 |
106 | 不支持的响应类型 |
107 | 不支持的传输加密类型 |
108 | 应用ID无效,注册账号,登录后台创建应用并完成绑定,可获得应用ID和应用密钥等信息 |
109 | batchLog格式不正确 |
110 | 无相关服务的有效应用,应用没有绑定服务。注:某些服务的结果发音需要tts服务,需要在控制台创建语音合成实例绑定应用后方能使用。 |
111 | 开发者账号无效 |
112 | 请求服务无效 |
113 | q不能为空 |
114 | 不支持的图片传输方式 |
201 | 解密失败,可能为DES,BASE64,URLDecode的错误 |
202 | 签名检验失败,如果确认应用ID和应用密钥的正确性,仍返回202,一般是编码问题。请确保翻译文本 q 为UTF-8编码. |
203 | 访问IP地址不在可访问IP列表 |
205 | 请求的接口与应用的平台类型不一致,确保接入方式(Android SDK、IOS SDK、API)与创建的应用平台类型一致。如有疑问请参考入门指南 |
206 | 因为时间戳无效导致签名校验失败 |
207 | 重放请求,接口salt+curtime来防重放(即一个请求不可以被请求2次 |
303 | 服务异常 |
405 | 鉴权失败 |
IPP2001 | 不支持的command取值 |
IPP2002 | 房间ID错误 |
IPP2003 | 主播ID错误 |
IPP2004 | 通道已满 |
IPP2005 | api请求失败 |
IPP2006 | 房间启动失败 |
IPP2007 | command处理失败 |