查询企业级会议与会统计数据
描述
该接口用于查询企业内与会者数据统计：
- 查询与会用户统计数据，按日/按月统计。
- 查询与会硬件终端统计数据，按日/按月统计。
- 查询与会设备统计数据，按日/按月统计。
仅旗舰版企业的企业管理员有权限查询。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/metrics/dashboard/statistic/conference/participant
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
offset |
否 |
Integer |
Query |
查询偏移量。
|
|
limit |
否 |
Integer |
Query |
查询的条目数量。
|
|
timeUnit |
是 |
String |
Query |
查询时间维度，取值：
|
|
startTime |
是 |
String |
Query |
查询时间范围的开始时间，格式根据timeUnit的取值而定。
|
|
endTime |
是 |
String |
Query |
查询时间范围的结束时间，格式根据timeUnit的取值而定。
|
|
category |
是 |
String |
Query |
查询分类，取值：
|
|
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 StatisticParticipateDataItem objects |
会议与会数据按时间点统计的查询结果数组。 |
|
参数名称 |
参数类型 |
描述 |
|---|---|---|
|
time |
String |
日期/月份。 |
|
confUserName |
String |
与会用户名称。 category = user_participate_info时有效。 |
|
confUserAccount |
String |
与会用户账户。 category = user_participate_info时有效。 |
|
confUserDeptName |
String |
与会用户所属部门。 category = user_participate_info时有效。 |
|
confUserCount |
String |
用户与会数。 category = user_participate_info时有效。 |
|
confUserDuration |
String |
用户与会时长(秒)。 category = user_participate_info时有效。 |
|
confHardTerminalName |
String |
与会硬件终端名称。 category = hard_terminal_participate_info时有效。 |
|
confHardTerminalModel |
String |
与会硬件终端型号。 category = hard_terminal_participate_info时有效。 |
|
confHardTerminalUserId |
String |
与会硬件终端的用户ID。 category = hard_terminal_participate_info时有效。 |
|
confHardTerminalCount |
String |
硬件终端与会数。 category = hard_terminal_participate_info时有效。 |
|
confHardTerminalDuration |
String |
硬件终端与会时长(秒)。 category = hard_terminal_participate_info时有效。 |
|
deviceType |
String |
与会设备类型。 category = participant_type_info时有效。 |
|
deviceVersion |
String |
与会设备版本。 category = participant_type_info时有效。 |
|
deviceAttendanceCount |
String |
设备与会数。 category = participant_type_info时有效。 |
请求消息示例
GET /v1/metrics/dashboard/statistic/conference/participant?timeUnit=D&startTime=2021-04-01&endTime=2021-04-30&category=user_participate_info&offset=0&limit=4 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": 3,
"limit": 4,
"offset": 0,
"data": [{
"time": "2021-04-18",
"confUserName": "linghaiwen",
"confUserAccount": "lingwenhai",
"confUserDeptName": "1",
"confUserCount": "1",
"confUserDuration": "53"
},
{
"time": "2021-04-19",
"confUserName": "zhaoyuwei",
"confUserAccount": "haiwenling",
"confUserDeptName": "lingwenhai",
"confUserCount": "3",
"confUserDuration": "33"
},
{
"time": "2021-04-19",
"confUserName": "linghaiwen",
"confUserAccount": "lingwenhai",
"confUserDeptName": "lingwenhai",
"confUserCount": "2",
"confUserDuration": "22"
}
]
}
错误码
当您使用华为云会议服务端API时，如果遇到“MBI”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/conference/participant?timeUnit=D&startTime=2021-04-01&endTime=2021-04-30&category=user_participate_info&offset=0&limit=4"
