Consulta de QoS de participantes en una reunión
Descripción
Esta API se utiliza para consultar la QoS de los participantes en una reunión en una empresa.
Rol de permisos = Empresa de edición Premium/Standard + Administrador
Depuración
Puede depurar esta API en API Explorer.
Prototipo
Método de solicitud |
GET |
---|---|
Dirección de solicitud |
/v1/metrics/conference/participants |
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
---|---|---|---|---|
confUUID |
Sí |
String |
Query |
Reunión de UUID. El valor contiene hasta 64 bytes. |
confType |
Sí |
String |
Query |
Tipo de reunión.
|
offset |
No |
Integer |
Query |
Desplazamiento de consulta.
|
limit |
No |
Integer |
Query |
Número de registros a consultar.
|
searchKey |
No |
String |
Query |
El tema de la reunión, el programador y la ID de la reunión se pueden utilizar como palabras clave para la concordancia difusa. El valor contiene hasta 512 bytes. |
X-Access-Token |
Yes |
String |
Header |
Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación. |
Códigos de estado
Código de estado de HTTP |
Descripción |
---|---|
400 |
Solicitud incorrecta. Parámetros no válidos. |
401 |
No autorizado. La autenticación no se realiza o falla. |
403 |
Prohibido. Permisos insuficientes. |
500 |
Excepción del servidor. |
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
count |
Integer |
Número total de registros. |
limit |
Integer |
Número de registros consultados. |
offset |
Integer |
Desplazamiento de consulta. |
data |
Array of QosParticipantInfo objects |
Lista de participantes. Se pueden devolver hasta 500 registros. |
Parámetro |
Tipo |
Descripción |
---|---|---|
confUUID |
String |
UUID de reunión. |
conferenceID |
String |
ID de reunión. |
participantID |
String |
ID de participante. |
userUUID |
String |
UUID de usuario. |
displayName |
String |
Nombre o alias de participante. |
deptName |
String |
Departamento. |
terminalType |
String |
Tipo de terminal.
|
role |
String |
Papel de participante.
|
ipAddress |
String |
Dirección IP del participante. |
country |
String |
País/Región. |
province |
String |
Provincia (solo en China). |
city |
String |
Ciudad (solo en China). |
appVersion |
String |
Versión de la aplicación Huawei Cloud Meeting. |
joinTime |
Long |
Hora en que el participante se une a la reunión (hora UTC). El valor es una marca de tiempo Unix, en milisegundos. |
leftTime |
Long |
Hora en que el participante abandona la reunión (hora UTC). El valor es una marca de tiempo Unix, en milisegundos. Nota:
|
systemInfo |
String |
Información de sistema. |
networkType |
String |
Tipo de red. |
alarm |
String |
Alarma general. Valores: YES y NO. Nota:
|
audioAlarmSend |
String |
Alarma de audio Tx. Las opciones son Yes y No. Nota:
|
videoAlarmSend |
String |
Alarma de video Tx. Las opciones son Yes y No. Nota:
|
screenAlarmSend |
String |
Alarma Tx para compartir pantalla. Las opciones son Yes y No. Nota:
|
audioAlarmRec |
String |
Alarma de audio Rx. Las opciones son Yes y No. Nota:
|
videoAlarmRec |
String |
Alarma de video Rx. Las opciones son Yes y No. Nota:
|
screenAlarmRec |
String |
Alarma Rx para compartir pantalla. Las opciones son Yes y No. Nota:
|
cpuAlarm |
String |
Alarma de CPU. Las opciones son Yes y No. Nota:
|
microphoneInfo |
String |
Micrófono. |
speakerInfo |
String |
Portavoz. |
cameraInfo |
String |
Cámara. |
dataCenter |
String |
Centro de datos. |
leftReason |
Integer |
Motivo para salir de la reunión. Este parámetro se utiliza únicamente para identificar el motivo de la salida de la reunión y no se utiliza para determinar si el participante ha salido de la reunión. El valor inicial de este parámetro para los participantes en línea es 0. Nota:
|
existQos |
Boolean |
Si existen datos de QoS del participante. Nota:
|
Ejemplo de solicitud
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)
Ejemplo de respuesta
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 error
Si se devuelve un código de error que comienza con MBI cuando usa esta API, corrija el error siguiendo las instrucciones proporcionadas en Centro de errores de la API de Huawei Cloud.
Ejemplo 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