Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Meeting/ Referencia de la API del servidor/ Panel de control/ QoS de reunión/ APIs/ Consulta de QoS de participantes en una reunión
Actualización más reciente 2023-01-31 GMT+08:00

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

Tabla 1 Prototipo

Método de solicitud

GET

Dirección de solicitud

/v1/metrics/conference/participants

Protocolo de transporte

HTTPS

Parámetros de solicitud

Tabla 2 Parámetros

Parámetro

Obligatorio

Tipo

Localización

Descripción

confUUID

String

Query

Reunión de UUID. El valor contiene hasta 64 bytes.

confType

String

Query

Tipo de reunión.

  • en línea: reunión en curso.
  • historia: reunión histórico.

offset

No

Integer

Query

Desplazamiento de consulta.

  • El valor es mayor o igual a 0. El valor predeterminado es 0.
  • Si el valor es mayor o igual al número máximo de registros, se devuelven los datos de la última página.

limit

No

Integer

Query

Número de registros a consultar.

  • Rango de valores: 1 a 500. El valor predeterminado es 20.

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

Tabla 3 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

Tabla 4 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.

Tabla 5 Estructura de datos de QosParticipantInfo

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.

  • PC: PC.
  • MOBILE: teléfono móvil.
  • PAD: tableta.
  • MAC: MacBook.
  • WEB: web, por ejemplo, utilizando WebRTC para unirse a la reunión.
  • ROOM: sala de reuniones.
  • Terminal de hardware: se muestra el tipo de terminal duro específico, como TE50, HUAWEI IDEAHUB o CISCO.
  • OTHER: otros dispositivos.

role

String

Papel de participante.

  • host
  • guest
  • audience: asistente.

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:

  • Si el participante está en la reunión, el valor de leftTime es 0.
  • Si el participante ha abandonado la reunión, el valor de leftTime es el momento en que el participante abandona la reunión.

systemInfo

String

Información de sistema.

networkType

String

Tipo de red.

alarm

String

Alarma general. Valores: YES y NO.

Nota:

  • Si se genera una alarma para audio (Tx/Rx), vídeo (Tx/Rx), pantalla compartida (Tx/Rx) o CPU, el estado general de la alarma es YES.

audioAlarmSend

String

Alarma de audio Tx. Las opciones son Yes y No.

Nota:

  • Si la fluctuación, retardo o tasa de pérdida de paquetes de envío de audio alcanza el umbral de alarma, el estado de alarma de Tx de audio es YES.

videoAlarmSend

String

Alarma de video Tx. Las opciones son Yes y No.

Nota:

  • Si la fluctuación, retardo o tasa de pérdida de paquetes de envío de vídeo alcanza el umbral de alarma, el estado de alarma de Tx de vídeo es YES.

screenAlarmSend

String

Alarma Tx para compartir pantalla. Las opciones son Yes y No.

Nota:

  • Si la fluctuación, el retardo o la tasa de pérdida de paquetes de la compartición de pantalla de envío alcanza el umbral de alarma, el estado de alarma Tx de compartición de pantalla es YES.

audioAlarmRec

String

Alarma de audio Rx. Las opciones son Yes y No.

Nota:

  • Si la fluctuación, retardo o tasa de pérdida de paquetes del audio de recepción alcanza el umbral de alarma, el estado de alarma de Rx de audio es YES.

videoAlarmRec

String

Alarma de video Rx. Las opciones son Yes y No.

Nota:

  • Si la fluctuación, retardo o tasa de pérdida de paquetes del vídeo receptor alcanza el umbral de alarma, el estado de alarma de Rx de vídeo es YES.

screenAlarmRec

String

Alarma Rx para compartir pantalla. Las opciones son Yes y No.

Nota:

  • Si la fluctuación, retardo o tasa de pérdida de paquetes de la compartición de pantalla de recepción alcanza el umbral de alarma, el estado de alarma Rx de compartición de pantalla es YES.

cpuAlarm

String

Alarma de CPU. Las opciones son Yes y No.

Nota:

  • Si se genera una alarma para el uso máximo de la CPU de la aplicación o el sistema en el lado del dispositivo, el estado de la alarma de la CPU es YES.

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:

  • 0: El participante sale de la reunión normalmente.
  • 1: El participante sale de la reunión debido a una excepción de red.

existQos

Boolean

Si existen datos de QoS del participante.

Nota:

  • true: los datos QoS existen.
  • false: los datos QoS no existen.

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