Consulta do diretório empresarial
Descrição
Esta API é usada por um usuário ou administrador empresarial para consultar o diretório empresarial.
SLA
Taxa de sucesso de solicitação: > 99,99%
Atraso na solicitação TP99: 57 ms
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
Método de solicitação |
GET |
---|---|
Endereço de solicitação |
/v1/usg/abs/users |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
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. Valor padrão: 0. |
limit |
Não |
Integer |
Consulta |
Número de registros para consultar. Valor padrão: 100 |
searchKey |
Não |
String |
Consulta |
Critérios de pesquisa. Pesquisa difusa por conta, nome, número de celular e endereço de e-mail é suportada. |
deptCode |
Não |
String |
Consulta |
Código do departamento. maxLength: 32 minLength: 0 |
querySubDept |
Não |
Boolean |
Consulta |
Se consultar usuários em departamentos de nível inferior. Valor padrão: true. |
searchScope |
Não |
String |
Consulta |
|
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
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
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 UserDTO objects |
Detalhes do usuário empresarial. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
account |
String |
Conta de usuário. |
deptName |
String |
Departamento ao qual o usuário pertence. |
description |
String |
Descrição do usuário. |
|
String |
Endereço de e-mail. |
englishName |
String |
Nome em inglês do usuário. |
hidePhone |
Boolean |
Se deve ocultar o número de celular do usuário. Se o valor for true, o número de celular do usuário não será retornado quando outros usuários consultarem o usuário. |
id |
String |
ID do usuário. |
isHardTerminal |
Boolean |
Se a conta é uma conta de terminal físico. |
name |
String |
Nome do usuário. |
number |
String |
Número SIP. |
phone |
String |
Número de celular. |
signature |
String |
Assinatura do usuário. |
statusCode |
Integer |
Quando os detalhes do usuário são consultados, a resposta varia dependendo do cenário.
|
title |
String |
Título do trabalho. |
type |
String |
Tipo de usuário.
|
updateTime |
Long |
Hora em que as informações do usuário foram atualizadas pela última vez. |
vmrId |
String |
ID de reunião pessoal do usuário. |
deptCodes |
Array of strings |
Lista de códigos do departamento. |
Exemplo de solicitação
GET /v1/usg/abs/users Connection: keep-alive X-Access-Token: stbiQWNk96PwWeKsA32h81u9YSiK3xZhpNEU Content-Type: application/json Content-Length: 102 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 Connection: keep-alive http_proxy_id: 1fd3a76bc862c7bc7f7c9b09bea87647 Server: api-gateway X-Request-Id: 7f3dc39fd1af5f1f274641d46ed720ba { "offset": 0, "limit": 100, "count": 1, "data": [ { "id": "067f692ed2ce492182a44579f6bc82aa", "statusCode": 0, "account": "067f692ed2ce492182a44579f6bc82aa", "name": "TE30", "englishName": null, "email": null, "phone": null, "deptName": "wangyue", "number": "+991116057871", "signature": null, "title": null, "description": null, "vmrId": null, "updateTime": 1567405876353, "isHardTerminal": true, "hidePhone": false, "type": "HARD_TERMINAL", "deptCodes": [ "1" ] } ] }
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 no Centro de erros da API da Huawei Cloud.
Exemplo de comando cURL
curl -k -i -X GET -H 'X-Access-Token: stbiQWNk96PwWeKsA32h81u9YSiK3xZhpNEU' https://api.meeting.huaweicloud.com/v1/usg/abs/users