Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Meeting/ Referência de API do servidor/ Painel de controle/ QoS de reunião/ APIs/ Consulta de QoS de participantes em uma reunião
Atualizado em 2023-08-02 GMT+08:00

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

Tabela 1 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

Tabela 2 Parâmetros

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.

  • online: reunião em andamento.
  • history: reunião histórica.

offset

Não

Integer

Consulta

Deslocamento da consulta.

  • O valor é maior ou igual a 0. O valor padrão é 0.
  • Se o valor for maior ou igual ao número máximo de registros, os dados na última página serão retornados.

limit

Não

Integer

Consulta

Número de registros a serem consultados.

  • Intervalo de valores: 1 a 500. O valor padrão é 20.

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

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

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

Tabela 5 Estrutura de dados QosParticipantInfo

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.

  • PC: PC.
  • MOBILE: telemóvel.
  • PAD: tablet.
  • MAC: MacBook.
  • WEB: Web, por exemplo, usando WebRTC para participar da reunião.
  • ROOM: sala de reuniões.
  • Terminal de hardware: o tipo de terminal rígido específico, como TE50, HUAWEI IDEAHUB ou CISCO, é exibido.
  • OTHER: outros dispositivos.

role

String

Papel do participante.

  • host
  • guest
  • audience: 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:

  • se o participante estiver na reunião, o valor de leftTime será 0.
  • Se o participante saiu da reunião, o valor de leftTime é o momento em que o participante sai da reunião.

systemInfo

String

Informação do sistema.

networkType

String

Tipo de rede.

alarm

String

Alarme geral. Valores: YES e NO.

Observação:

  • se um alarme for gerado para áudio (Tx/Rx), vídeo (Tx/Rx), compartilhamento de tela (Tx/Rx) ou CPU, o status geral do alarme será YES.

audioAlarmSend

String

Alarme de Tx de áudio. As opções são Yes e No.

Observação:

  • se a taxa de tremulação, atraso ou perda de pacotes de envio de áudio atingir o limite de alarme, o status do alarme de Tx de áudio será YES.

videoAlarmSend

String

Alarme de Tx de vídeo. As opções são Yes e No.

Observação:

  • se a taxa de tremulação, atraso ou perda de pacotes de envio de vídeo atingir o limite de alarme, o status do alarme de Tx de vídeo será YES.

screenAlarmSend

String

Alarme de Tx de compartilhamento de tela. As opções são Yes e No.

Observação:

  • se a taxa de tremulação, atraso ou perda de pacotes do compartilhamento de tela de envio atingir o limite de alarme, o status do alarme de Tx de compartilhamento de tela será YES.

audioAlarmRec

String

Alarme de Rx de áudio. As opções são Yes e No.

Observação:

  • se a taxa de tremulação, atraso ou perda de pacotes do áudio de recepção atingir o limiar de alarme, o status do alarme de Rx de áudio será YES.

videoAlarmRec

String

Alarme de Rx de vídeo. As opções são Yes e No.

Observação:

  • se a taxa de tremulação, atraso ou perda de pacotes de recepção de vídeo atingir o limite de alarme, o status do alarme de Rx de vídeo é YES.

screenAlarmRec

String

Alarme de Rx de compartilhamento de tela. As opções são Yes e No.

Observação:

  • se a taxa de tremulação, atraso ou perda de pacotes de compartilhamento de tela de recebimento atingir o limite de alarme, o status de alarme de Rx de compartilhamento de tela será YES.

cpuAlarm

String

Alarme da CPU. As opções são Yes e No.

Observação:

  • se um alarme for gerado para o uso máximo da CPU do aplicativo ou sistema no lado do dispositivo, o status do alarme da CPU será YES.

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:

  • 0: o participante sai da reunião normalmente.
  • 1: o participante sai da reunião devido a uma exceção de rede.

existQos

Boolean

Se os dados QoS do participante existem.

Observação:

  • true: os dados QoS existem.
  • false: os dados de QoS não existem.

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