云直播查询实时会中成员列表
获取会中成员的列表及相关信息
1. 接口描述
接口名称:
/eventopenapi/realtime/meeting/participants/list
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
operatorId | String | 否 | 操作者信息 |
type | int | 否 | 类型, 1:获取所有用户(默认) 2:获取等候室用户 3:获取会中用户 |
page | Integer | 否 | 当前页, 默认1 |
pageSize | Integer | 否 | 当前页,默认50 |
请求示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId":620487,
"operatorId":"982340",
"page":1,
"pageSize":50
}
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
错误码
参数 | 值 | 说明 |
---|---|---|
code | 50209 | 会议未召开 |
code | 50104 | 会议已结束 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
eventId | Long | 直播会议ID |
title | String | 会议主题 |
startTime | Long | 预约开始时间 |
endTime | Long | 预约结束时间 |
totalCount | Integer | 总人数 |
currentPage | Integer | 当前页 |
list | JSON Array | 在线人员列表 |
list 参数说明
参数 | 类型 | 说明 |
---|---|---|
name | String | 用户名称 |
String | 邮箱 | |
mobile | String | 手机 |
onlineTime | Long | 上线时间 |
audioState | Boolean | 麦克风状态, true:开启, false:关闭 |
videoState | Boolean | 摄像头状态, true:开启, false:关闭 |
screenShareState | Boolean | 屏幕共享状态, true:开启, false:关闭 |
role | String | 主持人/联席主持人/参会人 |
deviceType | String | 设备类型(pc/mobile) |
tempUserId | Long | 在线人员临时用户ID |
输出示例
{
"timeStamp": 1645437961557,
"code": 200,
"msg": "Successfully to save the data!",
"data": {
"eventId":620487,
"title":"晨会",
"startTime":1645437961,
"endTime":1645557961,
"currentPage":1,
"totalCount":25,
"list":[
{
"name":"mike",
"email":"test234@sohu.com",
"mobile":13209871234,
"onlineTime": 1690352120,
"audioState":true,
"videoState":true,
"screenShareState":true,
"role":"参会人",
"deviceType":"pc",
"tempUserId":23412,
}
]
},
"requestId": "10.255.0.106_20220221_180559_1645437959691"
}