概述
Download
聚焦模式
字号
本文档主要描述 腾讯云智能数智人交互 aPaas 平台的开放接口协议。
注意事项
调用该接口前请确保下单购买了形象相关的产品。
接口调用方式
调用每个接口时需要在接口的 query 中传入公共参数及签名。参数及签名方式说明参考以下链接：
交互数智人 API 概览
功能类别 | API 标题 | | | 序号 | 接口 | 说明 | |
会话管理 | 创建会话 | | 1 | POST /v2/ivh/sessionmanager/sessionmanagerservice/createsession | 使用数智人平台项目创建会话，获取数智人画面的流播放地址。 | | |
| | | 2 | POST /v2/ivh/sessionmanager/sessionmanagerservice/createsessionbyasset | 使用客户有权限的形象资产直接创建会话，获取数智人画面的流播放地址。用于未在数智人平台创建项目的情况。 | | |
| | | 3 | POST /v2/ivh/sessionmanager/sessionmanagerservice/statsession | 查询指定会话的当前状态。 | | |
| | | 4 | POST /v2/ivh/sessionmanager/sessionmanagerservice/startsession | 会话就绪之后，必须调用此口才可以进行驱动。 | | |
| | | 9 | POST /v2/ivh/sessionmanager/sessionmanagerservice/closesession | 关闭会话，停止数智人推流，释放并发。 | | |
| 查询会话列表 | | - | POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofuin | 用于查询某个 uin 账号所有进行中的会话列表。 | | |
| | | - | POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofprojectid | 用于查询数智人项目下的所有进行中的会话列表。 | | |
| | | - | POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofassetvk | 用于查询个人资产形象下的所有进行中的会话列表。 | | |
数智人指令驱动 说明： | 长连接驱动(WebSocket) | | 5 | WSS /v2/ws/ivh/interactdriver/interactdriverservice/commandchannel | 建立 websocket 长连接通道，上行发送驱动指令、接收下行消息。 | | |
| | | 6 | - | 建立长连接通道后，可以通过 WebSocket 长连接发送文本驱动数智人。 | | |
| | | 6 | - | 建立长连接通道后，可以通过 websocket 长连接发送流式文本驱动数智人。 | | |
| | | 6 | - | 建立长连接通道后，可以通过 websocket 长连接发送音频驱动数智人。 | | |
| | | 7 | - | 在超过10分钟后如果云端未收到任何驱动指令会自动断开连接并释放并发。创建长通道后，通过发送心跳指令，可对会话进行续期。发送间隔大于30s，小于10分钟 | | |
| 直接驱动(HTTPS) | | 8 | POST /v2/ivh/interactdriver/interactdriverservice/command | HTTP 方式发送文本驱动指令 说明： 不用建立长连接通道，常用于试用、一句话驱动等场景。 | | |
其他接口 | | | - | POST /v2/ivh/sessionmanager/sessionmanagerservice/updatesessionconfig | 用于实时更新视频流画面中的人物大小、位置、背景图。此接口不再建议使用，后续不再继续迭代新特性。 | | |
| | | - | POST /v2/ivh/sessionmanager/sessionmanagerservice/gettrtcsign | 当创建直播会话时选择了 trtc 协议，除数字人之外的其他用户若需加入房间使用此接口获取该用户的入房秘钥。 | | |
接入流程
说明：
流程图中对应的序号，对应上面接口表格中的序号。
流程说明
通过下列步骤获取交互数智人服务：
1. 购买相关产品及服务：购买链接；
2. 创建会话：使用下列两种方式之一与云端创建会话，获取数智人视频流会话状态与流播放地址：
4. 播放视频流；
5. 开启会话：视频流就绪后，需要调用开启会话接口，使数智人可以通过指令进行驱动；
6. 发送驱动指令：各种驱动指令说明及要求请参考指令发送要求；
7. 关闭会话：交互完成后请关闭会话。
文档反馈