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/ Adición de un usuario

Actualización más reciente 2023-01-31 GMT+08:00

Ver PDF

Adición de un usuario

Descripción

Esta API es utilizada por un administrador de empresa para agregar un usuario.

SLA

Tasa de éxito de solicitudes: > 99.99%

Retardo de solicitud TP99: 125 ms

Depuración

Puede depurar esta API en API Explorer.

Prototipo

**Tabla 1** Prototipo
Método de solicitud	POST
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
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.
account	No	String	Body	Cuenta de usuario de la reunión en Huawei Cloud. Si se lleva este parámetro, se utiliza el valor. De lo contrario, el valor es generado automáticamente por el backend. La cuenta debe ser única en el sistema. La cuenta puede contener letras, números, guiones bajos (_), guiones (-), puntos (.), y arrobas (@), y no puede contener solo números. La arroba (@) no puede ir seguido de un punto (.). maxLength: 64 minLength: 0 Este parámetro se utiliza cuando se utiliza el modo de autenticación de cuenta y contraseña.
thirdAccount	No	String	Body	ID de usuario de terceros. Este parámetro se utiliza cuando se utiliza el modo de autenticación de ID de aplicación.
country	No	String	Body	País o región a la que pertenece el número de móvil. Valor predeterminado: chinaPR. maxLength: 255 minLength: 0
deptCode	No	String	Body	ID del departamento. Si este parámetro no se incluye, el departamento root se utiliza de forma predeterminada. Valor predeterminado: 1. maxLength: 32 minLength: 0
desc	No	String	Body	Observaciones. maxLength: 128 minLength: 0
email	No	String	Body	Dirección de correo. maxLength: 255 minLength: 0 NOTA: Especifique la dirección de correo electrónico o el número de teléfono móvil. Utilice el formato de dirección de correo electrónico unificada. Si la empresa desactiva la función SMS, la dirección de correo electrónico es obligatoria.
englishName	No	String	Body	Nombre en inglés del usuario. maxLength: 64 minLength: 0
function	No	UserFunctionDTO object	Body	Indicador de función de usuario.
hidePhone	No	Boolean	Body	Si se debe ocultar el número de móvil. Si este parámetro se establece en true, el número de móvil no se muestra en el directorio corporativo o en las reuniones. Valor predeterminado: false.
name	Sí	String	Body	Nombre del usuario. maxLength: 64 minLength: 1
phone	No	String	Body	Número de teléfono móvil, que debe contener el código del país. Por ejemplo, un número de móvil en China continental es +86xxxxxxxxxxx. Este parámetro se combina con el parámetro country. El número de móvil solo puede contener números. Se debe especificar el número de teléfono móvil o la dirección de correo electrónico. maxLength: 32 minLength: 0
pwd	No	String	Body	Contraseña de la cuenta de usuario. Si se lleva este parámetro, se utiliza el valor real. De lo contrario, el valor es generado por el backend de forma predeterminada. La contraseña debe cumplir los siguientes requisitos: La contraseña puede contener de 8 a 32 caracteres. La contraseña no puede ser la misma que la cuenta o la cuenta escrita al revés. La contraseña debe contener al menos dos de los siguientes: letras minúsculas, letras mayúsculas, números y caracteres especiales `~!@#$%^&*()-_=+\|[{}];:,'<.>/?.
sendNotify	No	String	Body	Ya sea para enviar notificaciones por correo electrónico y SMS para el registro. 0: no. Si este parámetro es nulo o se establece con otros valores, las notificaciones se envían de forma predeterminada. maxLength: 32 minLength: 0
signature	No	String	Body	Firma. maxLength: 512 minLength: 0
sortLevel	No	Integer	Body	Número de secuencia en el directorio corporativo. Un valor menor indica una posición más alta en el directorio corporativo. Valor predeterminado: 10000. maximum: 10000 minimum: 1
status	No	Integer	Body	Estado del usuario. 0: normal. 1: deshabilitado. Valor predeterminado: 0.
title	No	String	Body	Cargo. maxLength: 32 minLength: 0

**Tabla 3** Estructura de dato UserFunctionDTO
Parámetro	Obligatorio	Tipo	Localización	Descripción
enableRoom	No	Boolean	Cuerpo	Ya sea para habilitar la función de colaboración inteligente de pizarra. Si la función está habilitada, la cuenta se utiliza para la pizarra colaborativa inteligente y ocupa los recursos de la pizarra en la empresa. Si los recursos de la pizarra son insuficientes, la función no se puede habilitar. Valor predeterminado: false.

Códigos de estado

**Tabla 4** 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 5** Parámetros de respuesta
Parámetro	Tipo	Descripción
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.)
corp	CorpBasicInfoDTO object	Datos de registro de empresa, que se devuelven solo cuando los usuarios consultan los datos personales de sí mismos.
country	String	País o región a la que pertenece el número de móvil del usuario.
deptCode	String	Código de departamento.
deptName	String	Nombre del departamento.
deptNamePath	String	Ruta del nombre del departamento.
desc	String	Observaciones.
devType	QueryDeviceInfoResultDTO object	Tipo del dispositivo asociado.
email	String	Dirección de correo.
englishName	String	Nombre en inglés.
function	UserFunctionDTO object	Indicador de función de usuario.
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.
sipNum	String	Número de SIP.
sortLevel	Integer	Número de secuencia en el directorio corporativo. Un valor menor indica una posición más alta en el directorio corporativo.
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 TV inteligente única.
vmrList	Array of UserVmrDTO objects	Lista de salas de reuniones en la nube.

**Tabla 6** Estructura de dato QueryDeviceInfoResultDTO
Parámetro	Tipo	Descripción
deviceSize	String	Dimensiones del dispositivo.
model	String	Modelo del dispositivo.
purchaseChannel	String	Canal de compra de dispositivos.

Ejemplo de solicitud

POST /v1/usg/dcs/corp/member
Connection: keep-alive
Content-Type: application/json
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Content-Length: 173
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "englishName": "englishName",
    "country": "chinaPR",
    "signature": "signature-info",
    "hidePhone": false,
    "sendNotify": "0",
    "title": "manager",
    "sortLevel": 100000,
    "phone": "123456789",
    "function": {
        "enableRoom": true
    },
    "name": "name",
    "pwd": "",
    "account": "3e48b79b660e403cb5e0208f7be83961",
    "email": "email@huawei.com",
    "deptCode": "1",
    "desc": "desc",
    "status": "status"
}

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: 160
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Server: api-gateway
X-Request-Id: ebbb9b1e50d1ec63b78d8484d170173f

{
    "id": "f521bebcbb27422cb3241c4cb19942c5",
    "userAccount": "3e48b79b660e403cb5e0208f7be83961",
    "name": "name",
    "englishName": "englishName",
    "phone": "+86123456789",
    "country": "chinaPR",
    "email": "email@huawei.com",
    "sipNum": "+8657198480",
    "deptCode": "1",
    "deptName": "Root Department",
    "deptNamePath": "Root Department",
    "userType": 2,
    "adminType": 2,
    "signature": "signature-info",
    "title": "manager",
    "desc": "desc",
    "corp": null,
    "function": {
        "enableRoom": true
    },
    "devType": {
        "model": null,
        "deviceSize": null,
        "purchaseChannel": null
    },
    "status": 0,
    "sortLevel": 10000,
    "hidePhone": false,
    "visionAccount": null,
    "thirdAccount": "thirdAccount",
    "license": 0,
    "activeTime": 1601221696783,
    "vmrList": [
        {
            "id": "2c908bc76f61a5f2016f61bbfdf5039b",
            "vmrId": "912992631",
            "vmrName": "name's cloud meeting room",
            "vmrPkgId": null,
            "vmrPkgName": null,
            "vmrPkgParties": null,
            "vmrPkgLength": null,
            "status": "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 -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"account": "test963","country": "chinaPR","deptCode": "1","email": "test963@huawei.com","name": "test963","phone": "+86136********","pwd": "******"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member

Tema principal: APIs

Tema anterior: APIs

Tema siguiente: Modificación de un usuario