查询数智人项目下的会话列表

最近更新时间:2024-11-29 16:28:52

我的收藏

接口说明

用于查询数智人项目下的所有进行中的会话列表。

调用协议

HTTPS + JSON
POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofprojectid
Header Content-Type: application/json;charset=utf-8

请求参数

参数名称
类型
必选
描述
ReqId
String
单次请求唯一标识,长度为32的 uuid。
VirtualmanProjectId
String
数智人项目 ID。获取方式如图:




返回参数

参数名称
类型
必选
描述
ReqId
String
单次请求唯一标识。
Sessions
Session
会话列表数组

Session

名称
类型
必选
描述
UserId
String
用户的唯一标识。
SessionId
String
会话的唯一标识。
SessionStatus
int
会话状态。1:进行中(已就绪),2:已关闭,3:准备中(未就绪),4:建流失败
PlayStreamAddr
String
流播放地址,建流成功后返回
DriverType
String
数智人类型。1:文本驱动;3:语音驱动(原声)。
IsSessionStarted
bool
是否已经开启会话,只有开启状态,才可以发送驱动指令。
VirtualmanType
String
数智人类型名称。
CreateType
int
创建会话的方式。0:使用数智人项目ID创建会话;1:使用形象资产ID创建会话。
VirtualmanKey
string
数智人 VirtualmanKey,形象唯一标识。
AssetVirtualmanKey
string
形象资产 ID。
VirtualmanProjectId
string
数智人项目 ID。

请求示例

{
"Header": {},
"Payload": {
"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
"VirtualmanProjectId": "5c298g1ba5b34b4a8fb0806fe8fb3e6a"
}
}

返回示例

{
"Header": {
"Code": 0,
"Message": "",
"RequestID": "3c5a8d999d8e1fbc6c574595a1b31d5d"
},
"Payload": {
"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
"Sessions": [
{
"UserId": "virtualhuman",
"SessionId": "m318552187863054171",
"SessionStatus": 1,
"PlayStreamAddr": "rtmp://live.qq.com/live/m789",
"DriverType": 1,
"IsSessionStarted": true,
"VirtualmanType": "small_sample_2d",
"CreateType": 0,
"VirtualmanKey": "5c298g1ba5b34b4a8fb0806fe8fb3e6a",
"AssetVirtualmanKey": "",
"VirtualmanProjectId": "5c298g1ba5b34b4a8fb0806fe8fb3e6a"
}
]
}
}