查询会议用户信息
请求方法
GET
请求地址
/ctrl/meetings/{meetingNumber}/users
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
meetingNumber |
Query |
String |
是 |
会议号 |
audience |
Query |
Boolean |
否 |
默认不返回观众信息。当audience=true,则返回观众信息 |
HTTP状态码
返回值 |
描述 |
200 |
操作成功 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
404 |
找不到请求的资源 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
userId |
Integer |
用户Id |
displayName |
String |
用户名 |
userNumber |
String |
用户号码 |
endpointType |
String |
终端类型 |
isInvitee |
Boolean |
是否被邀请 |
userAgent |
String |
设备型号 |
role |
String |
用户角色,可选:host(支持人)、coHost(联席主持人)、attendee(参会者)、audience(观众) |
isInLobby |
Boolean |
是否在大厅 |
isHandUp |
Boolean |
是否举手 |
audio |
MediaStream |
音频能力 |
video |
MediaStream |
视频能力 |
share |
MediaStream |
辅流能力 |
+ MediaStream 对象定义
参数 |
数据类型 |
描述 |
deviceOn |
Boolean |
是否开启媒体设备 |
sendOn |
Boolean |
是否开启发送媒体流 |
请求消息示例
GET /ctrl/meetings/819700180001/users HTTP/1.1
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"meetingID":"4140403078715010671918",
"meetingNum":"819700180001",
"users":[
{
"userId":1,
"displayName":"cc",
"userNumber":"81970014005",
"endpointType":"desktop",
"isInvitee":false,
"role":"attendee",
"isInLobby":false,
"isHandUp":false,
"audio":{
"deviceOn":true,
"sendOn":false,
"recvOn":true
},
"video":{
"deviceOn":false,
"sendOn":false,
"recvOn":true
},
"share":{
"deviceOn":false,
"sendOn":false,
"recvOn":false
}
}
]
}