交互会话管理接口
更新时间：2025-04-14
接口说明
接口调用域名：https://open.xiling.baidu.com
接口鉴权和通用字段说明请查阅：接口通用说明
本文档提供的接口可以方便用户对交互会话进行管理，在用户发现云渲染交互资源并发不足无法拉流时，可以通过对云渲染交互会话进行查询，获取会话的相关信息，以帮助区分不同的会话，并可以主动断连部分会话以释放资源。
会话管理接口支持：
1.获取当前app id下进行中的云渲染交互会话列表
2.主动关闭交互会话
接口列表
查询会话列表
接口说明
查询当前 app id 下进行中的云渲染交互会话。
接口协议
GET /api/digitalhuman/open/v1/session/interaction/list
返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| sessions | list | 会话列表 |
| -- sessionId | string | 会话ID |
| -- brtcPreviewUrl | string | 会话视频流预览地址，用于区分会话 |
| -- startTime | string | 会话开始时间 |
返回示例
Plain
1{
2 "code": 0,
3 "message": {
4 "global": "success"
5 },
6 "result": {
7 "sessions": [
8 {
9 "sessionId": "r-xxx",
10 "brtcPreviewUrl": "https://brtc.cdn.bcebos.com/brtc.html?appid=xxx&roomname=xxxxx&listener_only=1",
11 "startTime": "2025-04-14T14:10:55+08:00"
12 }
13 ]
14 },
15 "requestId": "5b0cdc66-c6a8-4d85-a92e-a80b467a2fa4",
16 "success": true
17}错误码
| 错误码 | 描述 |
|---|---|
| 0 | 正常返回 |
| 4911 | 找不到app信息，请确认appId是否输入正确 |
| 4913 | 无法访问API，可能是app没有绑定对应的组件，或url输入错误，或访问的人像不可用 |
| 10001 | 签名校验失败 |
| 10002 | 签名信息为空 |
| 10003 | 签名格式错误 |
| 10004 | 未识别错误的通用错误码 |
| 10005 | 请求体JSON解析失败，请确认是否是合法的JSON格式 |
| 10006 | 参数校验不通过 |
| 10011 | 没有购买对应的商品 |
| 14001 | 内部服务异常，请稍后再试 |
| 14002 | 内部服务异常，网络拥堵 |
主动关闭会话
接口说明
主动关闭交互会话。
接口协议
DELETE /api/digitalhuman/open/v1/session/interaction?sessionId={sessionId}
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sessionId | list | 是 | 需要关闭会话的会话ID |
请求示例
Plain
1DELETE /api/digitalhuman/open/v1/session/interaction?sessionId=r-xxx返回示例
Plain
1{
2 "code": 0,
3 "message": {
4 "global": "OK"
5 },
6 "result": null,
7 "requestId": null,
8 "success": true
9}错误码
| 错误码 | 描述 |
|---|---|
| 0 | 正常返回 |
| 4911 | 找不到app信息，请确认appId是否输入正确 |
| 4913 | 无法访问API，可能是app没有绑定对应的组件，或url输入错误，或访问的人像不可用 |
| 10001 | 签名校验失败 |
| 10002 | 签名信息为空 |
| 10003 | 签名格式错误 |
| 10004 | 未识别错误的通用错误码 |
| 10005 | 请求体JSON解析失败，请确认是否是合法的JSON格式 |
| 10006 | 参数校验不通过 |
| 10011 | 没有购买对应的商品 |
| 14001 | 内部服务异常，请稍后再试 |
| 14002 | 内部服务异常，网络拥堵 |