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 reuniões em andamento
Atualizado em 2023-08-02 GMT+08:00
Ver PDF

Consulta de QoS de reuniões em andamento

Descrição

  • Esta API é usada para consultar QoS de reuniões em andamento em uma empresa.
  • Função de permissão = edição empresarial Premium/Standard + administrador

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/conferences/online

Protocolo de transporte

HTTPS

Parâmetros de solicitação

Tabela 2 Parâmetros

Parâmetro

Obrigatório

Tipo

Localização

Descrição

offset

Não

Integer

Consulta

Deslocamento de 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 de consulta

data

Array of QosConferenceInfo objects

Lista de reuniões em andamento, que são classificadas por hora de início em ordem decrescente. Até 500 registros podem ser devolvidos.
Tabela 5 Estrutura de dados QoSConferenceInfo

Parâmetro

Tipo

Descrição

confUUID

String

UUID da reunião.

conferenceID

String

ID da reunião.

subject

String

Tópico da reunião.

scheduserName

String

Nome do agendador da reunião.

deptName

String

Departamento.

alarm

String

Alarme geral. Valores: YES e NO.

Observação:

  • Se qualquer alarme de áudio, vídeo, compartilhamento de tela e CPU for gerado, o valor desse parâmetro será YES.

audioAlarm

String

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

Observação:

  • Se algum participante da reunião tiver um alarme de áudio, o valor desse parâmetro será YES.

videoAlarm

String

Alarme de vídeo Valores: YES e NO.

Observação:

  • Se algum participante da reunião tiver um alarme de vídeo, o valor deste parâmetro será YES.

screenAlarm

String

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

Observação:

  • Se algum participante da reunião tiver um alarme de compartilhamento de tela, o valor desse parâmetro será YES.

cpuAlarm

String

Alarme da CPU. Valores: YES e NO.

Observação:

  • Se algum participante da reunião tiver um alarme de CPU, o valor deste parâmetro será YES.

timeZoneID

String

Fuso horário de reunião em notificações de reunião. Para obter detalhes, consulte Mapeamento de fuso horário.

NOTA:
  • Por exemplo, se timeZoneID estiver definido como 26, o horário na notificação de reunião enviada pelo Huawei Cloud Meeting é Tue, Nov 11, 2021 00:00 - 02:00 (GMT) Greenwich Mean Time:Dublin, Edinburgh, Lisbon, London.

startTime

Long

Hora de início da reunião (hora UTC). O valor é um carimbo de data/hora Unix, em milissegundos.

endTime

Long

Hora de término da reunião (hora UTC). O valor é um carimbo de data/hora Unix, em milissegundos.

Observação:

  • Reunião em andamento: a reunião está em andamento. O valor de endTime é a hora estimada de término da reunião.
  • Reunião histórica: a reunião terminou. O valor de endTime é a hora em que a reunião termina.

duration

Integer

Duração da reunião, em minutos.

Observação:

  • Reunião em andamento: a reunião está em andamento. O valor da duration é 0.
  • Reunião histórica: a reunião terminou. O valor da duration é a duração real da reunião.

participants

Integer

Participantes.

Observação:

  • Um usuário é contado como um participante cada vez que o usuário ingressa na reunião.

webinar

Boolean

Se a reunião é um webinar.

Exemplo de solicitação

GET /v1/metrics/conferences/online?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",
		"subject": "R&D Morning Call",
		"scheduserName": "Secretary of Shenzhen Branch",
		"deptName": "XXXXX",
		"alarm": "YES",
		"audioAlarm": "NO",
		"videoAlarm": "YES",
		"screenAlarm": "NO",
		"cpuAlarm": "NO",
		"timeZoneID": "56",
		"startTime": 1618220740926,
		"endTime": 1618222194202,
		"duration": 32,
		"participants": 52,
		"webinar": false
	}]
}

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' https://api.meeting.huaweicloud.com/v1/metrics/conferences/online

Tópico principal: APIs