Convite de um usuário
Descrição
Esta API é usada para convidar um usuário a ingressar em uma empresa usando o número de celular ou o endereço de e-mail.
- Se o usuário convidado não existir no sistema do Huawei Cloud Meeting:
- O usuário precisa se registrar no Huawei Cloud Meeting para ingressar na empresa que usa a edição gratuita ou padrão.
- O usuário é adicionado diretamente à empresa que usa a edição premium. O usuário recebe a senha inicial da conta do Huawei Cloud Meeting e precisa alterar a senha ao fazer logon no Huawei Cloud Meeting usando o número de celular ou endereço de e-mail.
- Se o usuário convidado existir no sistema do Huawei Cloud Meeting, o usuário receberá uma mensagem SMS ou e-mail para confirmação. Depois de aceitar o convite, o usuário é adicionado à empresa. A senha da conta de usuário permanece inalterada.
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
Método de solicitação |
POST |
|---|---|
Endereço de solicitação |
/v1/usg/dcs/corp/member/add |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
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. |
contact |
Sim |
String |
Corpo |
O fundo identifica automaticamente se o número de celular ou endereço de e-mail é usado. Se o número de telemóvel for utilizado, o número de telemóvel tem de corresponder ao código do país/região. Observação: as empresas do site da China continental podem convidar usuários especificando endereços de e-mail ou números de celular dos usuários. Somente números de telemóvel que começam com +86 são suportados. As empresas no site internacional podem convidar usuários apenas especificando os endereços de e-mail dos usuários. |
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. |
desc |
Não |
String |
Corpo |
Observações. maxLength: 128 minLength: 0 |
name |
Sim |
String |
Corpo |
Nome do usuário. |
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. |
title |
Não |
String |
Corpo |
Título do trabalho. |
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 é realizada ou falha. |
403 |
Permissões insuficientes. |
500 |
Exceção do servidor. |
Parâmetros de resposta
Nenhum
Exemplo de solicitação
POST /v1/usg/dcs/corp/member/add
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)
{
"contact": "+8617379679094",
"country": "chinaPR",
"name": "Tom"
}
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 Pragma: No-cache Cache-Control: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT Server: api-gateway X-Request-Id: ebbb9b1e50d1ec63b78d8484d170173f
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 '{"contact": "+8617379679094","country": "chinaPR","name": "Tom"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member
