查询QoS会议与会者列表
描述
该接口用于查询企业内在线会议或历史会议的与会者QoS告警。仅旗舰版企业/标准版企业的企业管理员有权限查询。
仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员，并提供华为云会议企业ID。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
GET |
|---|---|
请求地址 |
/v1/metrics/conference/participants |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
confUUID |
是 |
String |
Query |
会议UUID。 |
confType |
是 |
String |
Query |
会议类别。
|
offset |
否 |
Integer |
Query |
查询偏移量。
|
limit |
否 |
Integer |
Query |
查询的条目数量。
|
searchKey |
否 |
String |
Query |
查询条件。与会者名称可作为搜索内容。长度限制为1-512个字符。 |
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
状态码
HTTP状态码 |
描述 |
|---|---|
400 |
Bad Request 客户端传参异常。 |
401 |
Unauthorized 未鉴权或鉴权失败。 |
403 |
Forbidden 权限受限。 |
500 |
服务端异常。 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
count |
Integer |
总记录数。 |
limit |
Integer |
查询条目数量。 |
offset |
Integer |
查询偏移量。 |
data |
Array of QosParticipantInfo objects |
QoS会议与会者列表。最多返回500条记录。 |
参数名称 |
参数类型 |
描述 |
|---|---|---|
confUUID |
String |
会议UUID。 |
conferenceID |
String |
会议ID。 |
participantID |
String |
与会者标识。 |
userUUID |
String |
用户UUID。 |
displayName |
String |
与会者的名称。 |
deptName |
String |
部门名称。 |
terminalType |
String |
入会终端类型。
|
role |
String |
与会者角色。
|
ipAddress |
String |
与会者的IP地址。 |
country |
String |
国家。 |
province |
String |
省市（仅限中国）。 |
city |
String |
城市（仅限中国）。 |
appVersion |
String |
华为云会议APP版本。 |
joinTime |
Long |
入会时间（UTC时间），Unix时间戳（单位毫秒）。 |
leftTime |
Long |
离会时间（UTC时间），Unix时间戳（单位毫秒）。
说明：
|
systemInfo |
String |
终端操作系统信息。 |
networkType |
String |
网络类型。 |
alarm |
String |
总体告警 。
|
audioAlarmSend |
String |
音频发送告警 。
|
videoAlarmSend |
String |
视频发送告警 。
|
screenAlarmSend |
String |
屏幕共享发送告警 。
|
audioAlarmRec |
String |
音频接收告警。
|
videoAlarmRec |
String |
视频接收告警。
|
screenAlarmRec |
String |
屏幕共享接收告警。
|
cpuAlarm |
String |
CPU告警。
|
microphoneInfo |
String |
麦克风。 |
speakerInfo |
String |
扬声器。 |
cameraInfo |
String |
摄像头。 |
dataCenter |
String |
数据中心。 |
leftReason |
Integer |
离会原因。此字段仅标识离会原因，不做为是否已离会的判断依据。正在与会人员的离会原因初始值 = 0。
|
existQos |
Boolean |
与会者是否存在QoS数据。
|
请求消息示例
GET /v1/metrics/conference/participants?confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&offset=0&limit=20&searchKey=深圳分部 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
响应消息示例
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2
{
"count": 1,
"limit": 10,
"offset": 0,
"data": [{
"confUUID": "a3d9a31c8af211eb8075a12479434adb",
"conferenceID": "98909587",
"participantID": "kxxwoo5hmo9khlmggklawbwiwfl999bw",
"userUUID": "ff80808167ef1edf0167f339533d05a6",
"displayName": "深圳分部",
"deptName": "XXXXX",
"terminalType": "PC",
"role": "host",
"ipAddress": "***.***.**.**",
"country": "中国",
"province": "四川省",
"city": "成都市",
"appVersion": "60.15.5",
"joinTime": 1618220940926,
"leftTime": 1618221194202,
"systemInfo": "android-11",
"networkType": "wifi",
"alarm": "YES",
"audioAlarmSend": "YES",
"videoAlarmSend": "NO",
"screenAlarmSend": "NO",
"audioAlarmRec": "YES",
"videoAlarmRec": "YES",
"screenAlarmRec": "NO",
"cpuAlarm": "NO",
"microphoneInfo": "Microphone Array (Realtek(R) Audio)",
"speakerInfo": "Speakers/Headphones (Realtek(R) Audio)",
"cameraInfo": "Lenovo EasyCamera",
"dataCenter": "Region-China-2",
"leftReason": 0,
"existQos": true
}]
}
错误码
当您使用华为云会议服务端API时，如果遇到“MBI”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history' https://api.meeting.huaweicloud.com/v1/metrics/conference/participants
