Consulta de estatísticas de presença em reunião em uma empresa
Descrição
- Esta API é usada para consultar estatísticas sobre os participantes da reunião em uma empresa por dia ou mês.
- Esta API é usada para consultar estatísticas de presença sobre terminais físicos em uma empresa por dia ou mês.
- Esta API é usada para consultar estatísticas sobre dispositivos de reunião em uma empresa por dia ou mês.
- Função de permissão = edição empresarial Premium/Standard
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
|
Método de solicitação |
GET |
|---|---|
|
Endereço de solicitação |
/v1/metrics/dashboard/statistic/conference/participant |
|
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
|---|---|---|---|---|
|
offset |
Não |
Inteiro |
Consulta |
Deslocamento de consulta
|
|
limit |
Não |
Integer |
Consulta |
Número de registros a serem consultados.
|
|
timeUnit |
Sim |
String |
Consulta |
Dimensão de tempo de consulta. As opções são as seguintes:
|
|
startTime |
Sim |
String |
Consulta |
Hora de início da consulta. O formato depende do valor de timeUnit.
|
|
endTime |
Sim |
String |
Consulta |
Hora de fim da consulta. O formato depende do valor de timeUnit.
|
|
category |
Sim |
String |
Consulta |
Categoria da consulta. As opções são as seguintes:
|
|
X-Access-Token |
Sim |
String |
Cabeçalho |
Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação. |
Códigos de status
|
Código de status HTTP |
Descrição |
|---|---|
|
400 |
Solicitação inválida. Parâmetros inválidos. |
|
401 |
Não autorizado. A autenticação não é executada ou falha. |
|
403 |
Proibido. Permissões insuficientes. |
|
500 |
Exceção do servidor. |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
count |
Integer |
Número total de registros. |
|
limit |
Integer |
Número de registros consultados. |
|
offset |
Integer |
Deslocamento de consulta |
|
data |
Array of StatisticParticipateDataItem objects |
Matriz de resultados de consulta de dados de participação na reunião coletados por ponto de tempo. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
time |
String |
Data/mês. |
|
confUserName |
String |
Nome do participante. Este parâmetro só é válido quando category é definida como user_participate_info. |
|
confUserAccount |
String |
Conta do participante. Este parâmetro só é válido quando category é definida como user_participate_info. |
|
confUserDeptName |
String |
Departamento ao qual o participante pertence. Este parâmetro só é válido quando category é definida como user_participate_info. |
|
confUserCount |
String |
Número de vezes que o usuário participa de reuniões. Este parâmetro só é válido quando category é definida como user_participate_info. |
|
confUserDuration |
String |
Duração da presença do participante, em segundos. Este parâmetro só é válido quando category é definida como user_participate_info. |
|
confHardTerminalName |
String |
Nome de um terminal físico. Esse parâmetro é válido somente quando category é definida como hard_terminal_participate_info. |
|
confHardTerminalModel |
String |
Modelo do terminal físico. Esse parâmetro é válido somente quando category é definida como hard_terminal_participate_info. |
|
confHardTerminalUserId |
String |
ID de usuário do terminal físico. Esse parâmetro é válido somente quando category é definida como hard_terminal_participate_info. |
|
confHardTerminalCount |
String |
Número de vezes que o terminal físico participa de reuniões. Esse parâmetro é válido somente quando category é definida como hard_terminal_participate_info. |
|
confHardTerminalDuration |
String |
Duração da presença do terminal físico, em segundos. Esse parâmetro é válido somente quando category é definida como hard_terminal_participate_info. |
|
deviceType |
String |
Tipo de dispositivo de presença. Este parâmetro só é válido quando category é definida como participant_type_info. |
|
deviceVersion |
String |
Versão do dispositivo. Este parâmetro só é válido quando category é definida como participant_type_info. |
|
deviceAttendanceCount |
String |
Número de vezes que o dispositivo participa de reuniões. Este parâmetro só é válido quando category é definida como participant_type_info. |
Exemplo de solicitação
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)
Exemplo de resposta
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"
}
]
}
Códigos de erro
Se um código de erro começando com MBI for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.
Exemplo de comando 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"