Consulta del directorio corporativo
Descripción
Esta API es utilizada por un usuario o administrador de empresa para consultar el directorio corporativo.
SLA
Tasa de éxito de solicitudes: > 99.99%
Retardo de solicitud TP99: 57 ms
Depuración
Puede depurar esta API en Explorador de API.
Prototipo
|
Método de solicitud |
GET |
|---|---|
|
Dirección de solicitud |
/v1/usg/abs/users |
|
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
|---|---|---|---|---|
|
offset |
No |
Integer |
Query |
Desplazamiento de consulta. Si el valor excede el número máximo de registros disponibles, se devuelven los registros de la última página. Valor predeterminado: 0. |
|
limit |
No |
Integer |
Query |
Número de registros a consultar. Valor predeterminado 100 |
|
searchKey |
No |
String |
Query |
Criterios de búsqueda. Se admite la búsqueda difusa por cuenta, nombre, número de teléfono móvil y dirección de correo electrónico. |
|
deptCode |
No |
String |
Query |
Código de departamento. maxLength: 32 minLength: 0 |
|
querySubDept |
No |
Boolean |
Query |
Si consultar a los usuarios de los departamentos de nivel inferior. Valor predeterminado: true. |
|
searchScope |
No |
String |
Query |
|
|
X-Access-Token |
Sí |
String |
Header |
Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación. |
|
X-Request-Id |
No |
String |
Header |
ID de solicitud, que se utiliza para el seguimiento y la localización de fallos. Se recomienda utilizar un UUID. Si este parámetro no se incluye, se genera automáticamente un ID de solicitud. |
|
Accept-Language |
No |
String |
Header |
Idioma. Valores zh-CN para el chino (predeterminado) y en-US para el inglés. |
Códigos de estado
|
Código de estado de HTTP |
Descripción |
|---|---|
|
200 |
Operación exitosa. |
|
400 |
Parámetros no válidos |
|
401 |
La autenticación no se realiza o falla. |
|
403 |
Permisos insuficientes. |
|
500 |
Excepción del servidor. |
Parámetros de respuesta
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
count |
Integer |
Número total de registros. |
|
limit |
Integer |
Número de registros mostrados por página. Valor predeterminado: 10. |
|
offset |
Integer |
Número de la página de inicio de la consulta. El valor comienza desde 0. |
|
data |
Array of UserDTO objects |
Detalles de usuario de empresa. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
Cuenta |
String |
Cuenta de usuario. |
|
deptName |
String |
Departamento al que pertenece el usuario. |
|
Descripción |
String |
Descripción del usuario. |
|
Correo electrónico |
String |
Dirección de correo electrónico. |
|
englishName |
String |
Nombre en inglés del usuario. |
|
hidePhone |
Boolean |
Si se debe ocultar el número de móvil del usuario. Si el valor es de true no se devuelve el número de móvil del usuario cuando otros usuarios consultan al usuario. |
|
id |
String |
ID de usuario. |
|
isHardTerminal |
Boolean |
Si la cuenta es una cuenta de terminal duro. |
|
name |
String |
Nombre del usuario. |
|
number |
String |
Número de SIP. |
|
phone |
String |
Número móvil. |
|
signature |
String |
Firma de usuario. |
|
statusCode |
Integer |
Cuando se consultan los detalles del usuario, la respuesta varía según el escenario.
|
|
title |
String |
Título del trabajo. |
|
type |
String |
Tipo de usuario.
|
|
updateTime |
Long |
Hora en la que se actualizó por última vez la información del usuario. |
|
vmrId |
String |
ID de reunión personal del usuario. |
|
deptCodes |
Array of strings |
Lista de códigos de departamento. |
Solicitud de ejemplo
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)
Ejemplo de respuesta
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 error
Si se devuelve un código de error que comienza con MMC o USG cuando utiliza esta API, corrija el error siguiendo las instrucciones proporcionadas en el Centro de errores de la API de Huawei Cloud.
Ejemplo de comando cURL
curl -k -i -X GET -H 'X-Access-Token: stbiQWNk96PwWeKsA32h81u9YSiK3xZhpNEU' https://api.meeting.huaweicloud.com/v1/usg/abs/users
