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/ Gerenciamento de usuário/ APIs/ Consulta de usuários em páginas
Atualizado em 2023-08-02 GMT+08:00
Ver PDF

Consulta de usuários em páginas

Descrição

Esta API é usada por um administrador empresarial para consultar usuários empresariais em páginas.

SLA

Taxa de sucesso de solicitação: > 99,99%

Atraso na solicitação TP99: 644 ms

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/usg/dcs/corp/member

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 Se o valor exceder o número máximo de registros disponíveis, os registros na última página serão retornados.

limit

Não

Integer

Consulta

Número de registros para consultar.

Valor padrão: 10.

searchKey

Não

String

Consulta

Critérios de pesquisa. Pesquisa difusa por nome, número de celular, endereço de e-mail, conta e ID de usuário de terceiros é suportada.

sortField

Não

String

Consulta

Campo de classificação.

Restrições

  • O valor contém até 64 caracteres.

Opções:

  • userType
  • adminType
  • ldapAccount
  • deptCode
  • status
  • sortLevel

isAsc

Não

Boolean

Consulta

Se classificar registros em ordem crescente.

deptCode

Não

String

Consulta

Código do departamento. Se este parâmetro não for especificado, todos os departamentos serão consultados.

enableSubDept

Não

Boolean

Consulta

Se consultar subdepartamentos.

Valor padrão: true.

adminType

Não

Integer

Consulta

Tipo de administrador.

1: administrador comum.

2: não-administrador.

enableRoom

Não

Boolean

Consulta

Seja para ativar a função de quadro branco de colaboração inteligente. Se esse parâmetro não for especificado, todos os quadros brancos serão consultados.

userType

Não

Array of integers

Consulta

Tipo de usuário. Se a solicitação não contiver esse parâmetro, os usuários comuns serão consultados por padrão.

  • 2: usuário comum.
  • 12: usuário de TV inteligente.
  • 13: usuário do IdeaHub.

status

Não

Integer

Consulta

Status do usuário.

0: normal.

1: desativado.

Se esse parâmetro não for especificado, todos os usuários serão consultados.

containsUnActive

Não

Boolean

Consulta

Se consultar terminais inativos.

Valor padrão: false.

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-Request-Id

Não

String

Cabeçalho

ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente.

Accept-Language

Não

String

Cabeçalho

Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês.

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

count

Integer

Número total de registros.

limit

Integer

Número de registros exibidos por página.

Valor padrão: 10.

offset

Integer

Número da página inicial da consulta. O valor começa em 0.

data

Array of SearchUserResultDTO objects

Detalhes do usuário empresarial.
Tabela 5 Estrutura de dados SearchUserResultDTO

Parâmetro

Tipo

Descrição

activeCode

String

Código de ativação.

activeCodeExpireTime

Long

Tempo de expiração do código de ativação, que é um carimbo de data/hora UTC.

activeTime

Long

Tempo de ativação (carimbo de data/hora UTC).

adminType

Integer

Tipo de administrador.

  • 0: administrador padrão (super).
  • 1: administrador comum.
  • 2: membro comum da empresa (Esse valor é válido somente quando UserType é definido como 2.)

country

String

País ou região a que o número de telemóvel pertence.

deptCode

String

Código do departamento.

deptNamePath

String

Caminho do nome do departamento.

desc

String

Observações.

email

String

Endereço de e-mail.

englishName

String

Nome em inglês.

expireTime

Long

Tempo de expiração de um terminal ativado, que é um carimbo de data/hora UTC.

hidePhone

Boolean

Seja para esconder o número de celular.

id

String

ID do usuário.

license

Integer

Licença.

  • 0: utilização comercial.

  • 1: avaliação gratuita.

name

String

Nome do usuário.

phone

String

Número de celular.

signature

String

Assinatura.

sortLevel

Integer

Número de sequência no diretório empresarial. Um valor menor indica uma posição mais alta no diretório empresarial.

maximum: 10000

minimum: 1

status

Integer

Status do usuário.

  • 0: normal.
  • 1: desativado.

thirdAccount

String

ID de usuário de terceiros.

title

String

Título do trabalho.

userAccount

String

Conta do Huawei Cloud Meeting.

userType

Integer

Tipo de usuário.

2: membro da empresa.

visionAccount

String

Conta da TV inteligente.

vmrId

String

ID pessoal da sala de reunião na nuvem.

Exemplo de solicitação

GET /v1/usg/dcs/corp/member
Connection: keep-alive
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Content-Type: application/json
Content-Length: 125
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: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 63facce44898efa03629afd189da7f0f

{
    "count": 1,
    "data": [
        {
            "activeCode": null,
            "activeCodeExpireTime": null,
            "activeTime": 1601221696783,
            "adminType": 2,
            "country": "chinaPR",
            "deptCode": "1",
            "deptNamePath": "Root Department",
            "desc": "desc",
            "email": "email@huawei.com",
            "englishName": "englishName",
            "expireTime": null,
            "hidePhone": false,
            "id": "a7f78791553d4ec6b3a4b721f0946286",
            "license": 0,
            "name": "name",
            "phone": "+86123456789",
            "signature": "signature",
            "sortLevel": 10000,
            "status": 0,
            "thirdAccount": "thirdAccount",
            "title": "manager",
            "userAccount": "4036ca5e54d144d9b9e3ed25b9368d3a",
            "userType": 2,
            "visionAccount": null,
            "vmrId": "911150978"
        }
    ],
    "limit": 10,
    "offset": 0
}

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: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member
Tópico principal: APIs