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.
Atualizado em 2023-08-02 GMT+08:00

Consulta de detalhes da reunião

Descrição

  • Esta API é usada para consultar detalhes de todas as reuniões no domínio de gerenciamento de um administrador ou consultar detalhes de todas as reuniões gerenciadas por um usuário comum.
  • Você pode consultar apenas reuniões em andamento e próximas. Para obter detalhes sobre como consultar detalhes sobre uma reunião histórica, consulte Visualização de detalhes da reunião histórica.

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/mmc/management/conferences/confDetail

Protocolo de transporte

HTTPS

Parâmetros de solicitação

Tabela 2 Parâmetros

Parâmetro

Obrigatório

Tipo

Localização

Descrição

conferenceID

Sim

String

Consulta

ID da reunião.

offset

Não

Integer

Consulta

Índice da página da lista de participantes a retornar. Valor padrão: 0. Este parâmetro é usado para exibir os dados de PageParticipant por página.

limit

Não

Integer

Consulta

Número de registros de participantes a serem devolvidos. O valor padrão é 20. Este parâmetro é usado para exibir os dados de PageParticipant por página.

searchKey

Não

String

Consulta

Cadeia de palavra-chave usada para consulta. O valor pode conter de 1 a 128 caracteres.

userUUID

Não

String

Consulta

UUID de um usuário. Este parâmetro deve ser transportado durante a autenticação de terceiros.

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.

X-Type

Não

Integer

Cabeçalho

Valor padrão: 0.

  • 0: não distingua terminais e participantes.
  • 1: distinga terminais e participantes na consulta de paginação. Os resultados da consulta são combinados e retornados.
  • 2: consulta terminais e participantes e retorne os resultados da consulta separadamente.

X-Query-Type

Não

Integer

Cabeçalho

Esse parâmetro é válido somente quando X-Type é definido como 2. Valor padrão: 0

  • 0: consulte participantes.
  • 1: consulte terminais.

X-Authorization-Type

Não

String

Cabeçalho

Se a solicitação é enviada de um portal de terceiros.

X-Site-Id

Não

String

Cabeçalho

ID do site do HCS On-line onde a autenticação é realizada.

Códigos de status

Tabela 3 Códigos de status

Código de status HTTP

Descrição

200

Operação bem-sucedida.

400

Parâmetros inválidos.

401

A autenticação não é executada ou falha.

403

Permissões insuficientes.

500

Exceção do servidor.

Parâmetros de resposta

Tabela 4 Parâmetros de resposta

Parâmetro

Tipo

Descrição

conferenceData

ConferenceInfo object

Detalhes da reunião.

data

PageParticipant object

Lista de participantes.

Tabela 5 Estrutura de dados PageParticipant

Parâmetro

Tipo

Descrição

limit

Integer

Número de registros em cada página.

count

Integer

Número total de registros.

offset

Integer

Deslocamento do número de registros, ou seja, o número de registros antes desta página.

data

Array of ParticipantInfo objects

Informações sobre os participantes convidados durante o agendamento da reunião e convidados pelo anfitrião durante a reunião.

NOTA:
  • As informações sobre os participantes que ingressam proativamente na reunião não são retornadas.
Tabela 6 Estrutura de dados ParticipantInfo

Parâmetro

Tipo

Descrição

participantID

String

ID do participante.

name

String

Nome ou alias do participante.

subscriberID

String

Número do participante. Este campo está reservado.

role

Integer

Papel de participante na reunião.

  • 1: anfitrião da reunião.
  • 0: participante comum.

state

String

Status do usuário. Atualmente, o valor é fixado para MEETTING.

address

String

Informações sobre a sala de reuniões onde um terminal está localizado. Este campo está reservado.

attendeeType

String

O valor padrão é definido pelo servidor do Huawei Cloud Meeting.

  • normal: cliente suave.
  • telepresence: telepresença. Para telepresença de tela única e de tela tripla, use este valor. Este campo está reservado.
  • terminal: sala de reuniões ou terminal físico.
  • outside: participante externo.
  • mobile: número de celular.
  • telephone: número de telefone. Este campo está reservado.

ID da conta

String

ID da conta de um participante.

  • No cenário de autenticação de conta/senha, use o ID de uma conta do Huawei Cloud Meeting.
  • No cenário de autenticação de ID do aplicativo, use o ID de um usuário de terceiros.

phone2

String

Se attendeeType estiver definido como telepresence e o dispositivo usado para ingressar na reunião for uma telepresença de tela tripla, defina esse parâmetro como o número da tela esquerda. Este campo está reservado.

phone3

String

Se attendeeType estiver definido como telepresence e o dispositivo usado para ingressar na reunião for uma telepresença de tela tripla, defina esse parâmetro para o número de tela correto. Este campo está reservado.

email

String

Endereço de e-mail. O valor pode conter até 255 caracteres.

sms

String

Número de telemóvel para receber notificações por SMS. O valor pode conter até 127 caracteres.

deptName

String

Nome do departamento. O valor pode conter até 96 caracteres.

userUUID

String

UUID do usuário que agenda a reunião.

appId

String

ID de aplicação. Você pode criar um ID de aplicação para uma aplicação apenas uma vez. Para obter detalhes, consulte Solicitação de um ID de aplicação.

isAutoInvite

Integer

Se convidar automaticamente os participantes quando a reunião começar. O valor padrão é definido na configuração de nível empresarial. 0: não convide automaticamente os participantes.

  • 1: convide automaticamente os participantes.

isNotOverlayPidName

Boolean

Se os nomes dos sites não são sobrepostos.

  • true: os nomes dos sites não são sobrepostos.
  • false: os nomes dos sites são sobrepostos.

Exemplo de solicitação

GET /v1/mmc/management/conferences/confDetail?conferenceID=914083136
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: 1811
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5
Server: api-gateway
X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8

{
    "conferenceData": {
        "conferenceID": "914083136",
        "mediaTypes": "Voice,Data,Video",
        "subject": "user01's meeting",
        "size": 1,
        "timeZoneID": "56",
        "startTime": "2019-12-18 07:28",
        "endTime": "2019-12-18 09:28",
        "conferenceState": "Created",
        "accessNumber": "+991117",
        "language": "zh-CN",
        "passwordEntry": [
            {
                "conferenceRole": "chair",
                "password": "157599"
            },
            {
                "conferenceRole": "general",
                "password": "582397"
            }
        ],
        "userUUID": "ff808081699b56cb0169be103500012b",
        "scheduserName": "user8002",
        "multiStreamFlag": 1,
        "conferenceType": 0,
        "confType": "IMMEDIATELY",
        "isAutoMute": 1,
        "isAutoRecord": 0,
        "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f",
        "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d",
        "recordType": 0,
        "recordAuxStream": 0,
        "confConfigInfo": {
            "isSendNotify": true,
            "isSendSms": true,
            "isAutoMute": true
        },
        "vmrFlag": 0,
        "scheduleVmr": false,
        "isHasRecordFile": false,
        "partAttendeeInfo": [
            {
                "phone": "+991116003815",
                "name": "user01",
                "type": "normal"
            }
        ],
        "terminlCount": 0,
        "normalCount": 1,
        "deptName": "wangyue",
        "confUUID": "050c7898216811eaa6958bf3bb9ac167"
    },
    "data": {
        "offset": 0,
        "limit": 20,
        "count": 1,
        "data": [
            {
                "participantID": "+991116003815",
                "name": "user01",
                "role": 0,
                "state": "MEETTING",
                "attendeeType": "normal",
                "accountId": "user01"
            }
        ]
    }
}

Códigos de erro

Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas na 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/mmc/management/conferences/confDetail?conferenceID=914083136'