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/ Adição de um usuário

Atualizado em 2023-08-02 GMT+08:00

Ver PDF

Adição de um usuário

Descrição

Esta API é usada por um administrador empresarial para adicionar um usuário.

SLA

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

Atraso na solicitação TP99: 125 ms

Depuração

Você pode depurar essa API no API Explorer.

Protótipo

**Tabela 1** Protótipo
Método de solicitação	POST
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
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.
account	Não	String	Corpo	Conta de usuário do Huawei Cloud Meeting. Se este parâmetro é transportado, o valor é usado. Caso contrário, o valor é gerado automaticamente pelo back-end. A conta deve ser única no sistema. A conta pode conter letras, números, sublinhados (_), hifens (-), pontos (.) e sinais de arroba (@) e não pode conter apenas números. O sinal de arroba (@) não pode ser seguido por um ponto (.). maxLength: 64 minLength: 0 Esse parâmetro é usado quando o modo de autenticação de conta e senha é usado.
thirdAccount	Não	String	Corpo	ID de usuário de terceiros. Esse parâmetro é usado quando o modo de autenticação do ID da aplicação é usado.
country	Não	String	Corpo	País ou região a que o número de telemóvel pertence. Valor padrão: chinaPR. maxLength: 255 minLength: 0
deptCode	Não	String	Corpo	ID do departamento. Se este parâmetro não for transportado, o departamento raiz é usado por padrão. Valor padrão: 1. maxLength: 32 minLength: 0
desc	Não	String	Corpo	Observações. maxLength: 128 minLength: 0
E-mail	Não	String	Corpo	Endereço de e-mail. maxLength: 255 minLength: 0 NOTA: Especifique o endereço de e-mail ou o número de celular. Use o formato de endereço de e-mail unificado. Se a empresa desativar a função SMS, o endereço de e-mail é obrigatório.
englishName	Não	String	Corpo	Nome em inglês do usuário. maxLength: 64 minLength: 0
function	Não	UserFunctionDTO object	Corpo	Sinalizador de função do usuário.
hidePhone	Não	Boolean	Corpo	Seja para esconder o número de celular. Se esse parâmetro for definido como true, o número de celular não será exibido no diretório empresarial ou nas reuniões. Valor padrão: false.
name	Sim	String	Corpo	Nome do usuário. maxLength: 64 minLength: 1
phone	Não	String	Corpo	Número de celular, que deve conter o código do país. Por exemplo, um número de celular na China continental é +86xxxxxxxxxxx. Este parâmetro é combinado com o parâmetro country. O número de celular pode conter apenas números. O número de celular ou endereço de e-mail deve ser especificado. maxLength: 32 minLength: 0
pwd	Não	String	Corpo	Senha da conta de usuário. Se este parâmetro é transportado, o valor real é usado. Caso contrário, o valor é gerado pelo back-end por padrão. A senha deve atender aos seguintes requisitos: A senha pode conter de 8 a 32 caracteres. A senha não pode ser a mesma que a conta ou a conta soletrada para trás. A senha deve conter pelo menos dois dos seguintes itens: letras minúsculas, letras maiúsculas, números e caracteres especiais `~!@#$%^&*()-_=+\|[{}];:",'<.>/?.
sendNotify	Não	String	Corpo	Se enviar notificações por e-mail e SMS para registro. 0: não. Se esse parâmetro for nulo ou definido para outros valores, as notificações são enviadas por padrão. maxLength: 32 minLength: 0
signature	Não	String	Corpo	Assinatura. maxLength: 512 minLength: 0
sortLevel	Não	Integer	Corpo	Número de sequência no diretório empresarial. Um valor menor indica uma posição mais alta no diretório empresarial. Valor padrão: 10000. maximum: 10000 minimum: 1
status	Não	Integer	Corpo	Status do usuário. 0: normal. 1: desativado. Valor padrão: 0.
title	Não	String	Corpo	Título do trabalho. maxLength: 32 minLength: 0

**Tabela 3** Estrutura de dados UserFunctionDTO
Parâmetro	Obrigatório	Tipo	Localização	Descrição
enableRoom	Não	Boolean	Corpo	Se ativar a função de colaboração de quadro branco inteligente. Se a função estiver ativada, a conta será usada para o quadro branco inteligente empresarial e ocupará os recursos do quadro branco na empresa. Se os recursos do quadro branco forem insuficientes, a função não poderá ser ativada. Valor padrão: false.

Códigos de status

**Tabela 4** 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 5** Parâmetros de resposta
Parâmetro	Tipo	Descrição
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.)
corp	CorpBasicInfoDTO object	Detalhes de registro da empresa, que são retornados apenas quando os usuários consultam os dados pessoais de si mesmos.
country	String	País ou região ao qual o número de celular do usuário pertence.
deptCode	String	Código do departamento.
deptName	String	Nome do departamento.
deptNamePath	String	Caminho do nome do departamento.
desc	String	Observações.
devType	QueryDeviceInfoResultDTO object	Tipo do dispositivo associado.
email	String	Endereço de e-mail.
englishName	String	Nome em inglês.
function	UserFunctionDTO object	Sinalizador de função do usuário.
hidePhone	Boolean	Se 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.
sipNum	String	Número do SIP.
sortLevel	Integer	Número de sequência no diretório empresarial. Um valor menor indica uma posição mais alta no diretório empresarial.
status	Integer	Estado 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 exclusiva da TV inteligente.
vmrList	Array of UserVmrDTO objects	Lista de salas de reunião na nuvem.

**Tabela 6** Estrutura de dados QueryDeviceInfoResultDTO
Parâmetro	Tipo	Descrição
deviceSize	String	Dimensões do dispositivo.
model	String	Modelo do dispositivo.
purchaseChannel	String	Canal de compra do dispositivo.

Exemplo de solicitação

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"
}

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: 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 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 -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

Tópico principal: APIs

Tópico anterior: APIs

Próximo tópico: Modificação de um usuário