Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Meeting/ Referencia de la API del servidor/ Gestión de usuarios/ APIs/ Consulta de usuarios en páginas
Actualización más reciente 2023-01-31 GMT+08:00
Ver PDF
Compartir

Consulta de usuarios en páginas

Descripción

Esta API se utiliza por un administrador de empresa para consultar a los usuarios de empresa en las páginas.

SLA

Tasa de éxito de solicitudes: > 99.99%

Retardo de solicitud TP99: 644 ms

Depuración

Puede depurar esta API en API Explorer.

Prototipo

Tabla 1 Prototipo

Método de solicitud

GET

Dirección de solicitud

/v1/usg/dcs/corp/member

Protocolo de transporte

HTTPS

Parámetros de solicitud

Tabla 2 Parámetros

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.

limit

No

Integer

Query

Número de registros a consultar.

Valor predeterminado: 10.

searchKey

No

String

Query

Criterios de búsqueda. Se admite la búsqueda difusa por nombre, número de teléfono móvil, dirección de correo electrónico, cuenta y ID de usuario de terceros.

sortField

No

String

Query

Campo de clasificación.

Restricciones

  • El valor contiene hasta 64 caracteres.

Opciones:

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

isAsc

No

Boolean

Query

Si se ordenan los registros en orden ascendente.

deptCode

No

String

Query

Código de departamento. Si no se especifica este parámetro, se consultan todos los departamentos.

enableSubDept

No

Boolean

Query

Whether to query sub-departments.

Valor predeterminado: true.

adminType

No

Integer

Query

Tipo de administrador.

1: administrador común.

2: no administrador.

enableRoom

No

Boolean

Query

Si desea habilitar la función de pizarra de colaboración inteligente. Si no se especifica este parámetro, se consultan todas las pizarras.

userType

No

Array of integers

Query

Tipo de usuario. Si la solicitud no contiene este parámetro, los usuarios comunes se consultan de forma predeterminada.

  • 2: usuario común.
  • 12: usuario de Smart TV.
  • 13 usuario de IdeaHub.

status

No

Integer

Query

Estado del usuario.

0: normal.

1: deshabilitado.

Si no se especifica este parámetro, se consulta a todos los usuarios.

containsUnActive

No

Boolean

Query

Si se desea consultar terminales inactivos.

Valor predeterminado: false.

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 chino (predeterminado) y en-US para inglés.

Códigos de estado

Tabla 3 Códigos de estado

Código de estado de HTTP

Descripción

200

Operación exitosa.

400

Parámetros inválidos.

401

La autenticación no se realiza o falla.

403

Permisos insuficientes.

500

Excepción del servidor.

Parámetros de respuesta

Tabla 4 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 SearchUserResultDTO objects

Detalles de usuario de empresa.
Tabla 5 Estructura de datos SearchUserResultDTO

Parámetro

Tipo

Descripción

activeCode

String

Código de activación.

activeCodeExpireTime

Long

Tiempo de caducidad del código de activación, que es una marca de tiempo UTC.

activeTime

Long

Tiempo de activación (marca de tiempo UTC).

adminType

Integer

Tipo de administrador.

  • 0: administrador predeterminado (super).
  • 1: administrador común.
  • 2: miembro común de la empresa (Este valor es válido solo cuando UserType se establece en 2.)

country

String

País o región a la que pertenece el número de móvil.

deptCode

String

Código de departamento.

deptNamePath

String

Ruta del nombre del departamento.

desc

String

Observaciones.

email

String

Dirección de correo.

englishName

String

Nombre en inglés.

expireTime

Long

Tiempo de expiración de un terminal activado, que es una marca de tiempo UTC.

hidePhone

Boolean

Si se debe ocultar el número de móvil.

id

String

ID de usuario.

license

Integer

Licencia.

  • 0: uso comercial.

  • 1: prueba gratuita.

name

String

Nombre del usuario.

phone

String

Número de móvil.

signature

String

Firma.

sortLevel

Integer

Número de secuencia en el directorio corporativo. Un valor menor indica una posición más alta en el directorio corporativo.

maximum: 10000

minimum: 1

status

Integer

Estado del usuario.

  • 0: normal.
  • 1: deshabilitado.

thirdAccount

String

ID de usuario de terceros.

title

String

Cargo.

userAccount

String

Cuenta de Huawei Cloud Meeting.

userType

Integer

Tipo de usuario.

2: miembro de la empresa.

visionAccount

String

Cuenta de Smart TV.

vmrId

String

ID personal de la sala de reuniones en la nube.

Ejemplo de solicitud

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)

Ejemplo de respuesta

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 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 Centro de errores de la API de Huawei Cloud.

Ejemplo de comando cURL

curl -k -i -X GET -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member
Tema principal: APIs