Consulta de QoS de participantes em uma reunião
Descrição
Esta API é usada para consultar QoS de participantes em uma reunião de uma empresa.
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/conference/participants |
|
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
|---|---|---|---|---|
|
confUUID |
Sim |
String |
Consulta |
UUID de reunião. O valor contém até 64 bytes. |
|
confType |
Sim |
String |
Consulta |
Tipo de reunião.
|
|
offset |
Não |
Integer |
Consulta |
Deslocamento da consulta.
|
|
limit |
Não |
Integer |
Consulta |
Número de registros a serem consultados.
|
|
searchKey |
Não |
String |
Consulta |
O tópico da reunião, o agendador e o ID da reunião podem ser usados como palavras-chave para correspondência difusa. O valor contém até 512 bytes. |
|
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 da consulta. |
|
data |
Array of QosParticipantInfo objects |
Lista de participantes. Até 500 registros podem ser retornados. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
confUUID |
String |
UUID da reunião. |
|
conferenceID |
String |
ID da reunião. |
|
participantID |
String |
ID do participante. |
|
userUUID |
String |
UUID do usuário. |
|
displayName |
String |
Nome ou alias do participante. |
|
deptName |
String |
Departamento. |
|
terminalType |
String |
Tipo de terminal.
|
|
role |
String |
Papel do participante.
|
|
ipAddress |
String |
Endereço IP do participante. |
|
country |
String |
País/região. |
|
province |
String |
Província (apenas na China). |
|
city |
String |
Cidade (apenas na China). |
|
appVersion |
String |
Versão da aplicação Huawei Cloud Meeting. |
|
joinTime |
Long |
Hora em que o participante ingressa na reunião (hora UTC). O valor é um carimbo de data/hora Unix, em milissegundos. |
|
leftTime |
Long |
Hora em que o participante sai da reunião (hora UTC). O valor é um carimbo de data/hora Unix, em milissegundos. Observação:
|
|
systemInfo |
String |
Informação do sistema. |
|
networkType |
String |
Tipo de rede. |
|
alarm |
String |
Alarme geral. Valores: YES e NO. Observação:
|
|
audioAlarmSend |
String |
Alarme de Tx de áudio. As opções são Yes e No. Observação:
|
|
videoAlarmSend |
String |
Alarme de Tx de vídeo. As opções são Yes e No. Observação:
|
|
screenAlarmSend |
String |
Alarme de Tx de compartilhamento de tela. As opções são Yes e No. Observação:
|
|
audioAlarmRec |
String |
Alarme de Rx de áudio. As opções são Yes e No. Observação:
|
|
videoAlarmRec |
String |
Alarme de Rx de vídeo. As opções são Yes e No. Observação:
|
|
screenAlarmRec |
String |
Alarme de Rx de compartilhamento de tela. As opções são Yes e No. Observação:
|
|
cpuAlarm |
String |
Alarme da CPU. As opções são Yes e No. Observação:
|
|
microphoneInfo |
String |
Microfones. |
|
SpeakerInfo |
String |
Falante. |
|
cameraInfo |
String |
Câmera. |
|
dataCenter |
String |
Data center. |
|
leftReason |
Integer |
Motivo da saída da reunião. Esse parâmetro é usado apenas para identificar o motivo da saída da reunião e não é usado para determinar se o participante deixou a reunião. O valor inicial deste parâmetro para os participantes online é 0. Observação:
|
|
existQos |
Boolean |
Se os dados QoS do participante existem. Observação:
|
Exemplo de solicitação
GET /v1/metrics/conference/participants?confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&offset=0&limit=20&searchKey=Shenzhen Branch 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": 1,
"limit": 10,
"offset": 0,
"data": [{
"confUUID": "a3d9a31c8af211eb8075a12479434adb",
"conferenceID": "98909587",
"participantID": "kxxwoo5hmo9khlmggklawbwiwfl999bw",
"userUUID": "ff80808167ef1edf0167f339533d05a6",
"displayName": "Shenzhen Branch",
"deptName": "XXXXX",
"terminalType": "PC",
"role": "host",
"ipAddress": "***.***.**.**",
"country": "China",
"province": "Sichuan",
"city": "Chengdu",
"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
}]
}
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' -d 'confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history' https://api.meeting.huaweicloud.com/v1/metrics/conference/participants