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.
Atualizado em 2023-08-02 GMT+08:00

Adição de um terminal

Descrição

Esta API é usada por um administrador empresarial para adicionar um terminal físico. Os terminais físicos incluem DP300, série HUAWEI Bar, HUAWEI Board e série TE.

SLA

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

Atraso na solicitação TP99: 95 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/device

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.

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. O valor padrão é o departamento raiz.

Valor padrão: 1.

maxLength: 32

minLength: 1

description

Não

String

Corpo

Descrição do terminal.

maxLength: 128

minLength: 0

email

Não

String

Corpo

Formato de endereço de e-mail unificado.

maxLength: 255

minLength: 0

model

Sim

String

Corpo

Modelo do dispositivo. O valor é um tipo enumerado. Atualmente, apenas a série TE e alguns terminais físicos de terceiros são suportados. Você pode obter os modelos de terminal usando a API em Obtenção de todos os modelos de terminal.

maxLength: 128

minLength: 1

name

Sim

String

Corpo

Nome do terminal, que pode ser personalizado. É aconselhável definir este parâmetro para um local específico para facilitar a identificação.

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.

maxLength: 32

minLength: 0

NOTA:

O número de celular ou endereço de e-mail deve ser especificado.

prjCodeMode

Não

Integer

Corpo

Modo de geração de código de projeção. Valor padrão: 0.

  • 0: modo automático.

    Neste modo, a complexidade do código é controlada com base no endereço IP relatado na mensagem. Para um endereço IP privado, um código de projeção simples é gerado. Para um endereço IP público, um código de projeção complexo é gerado.

  • 1: modo simples.
  • 2: modo complexo.

sendNotify

Não

String

Corpo

Se enviar notificações por e-mail e SMS.

  • 0: não.
  • Se este parâmetro for nulo ou definido para outros valores, as notificações por e-mail e SMS serão enviadas.

maxLength: 32

minLength: 0

sn

Não

String

Corpo

SN de terminal. O valor pode conter apenas números, letras e sublinhados (_).

maxLength: 30

minLength: 1

status

Não

Integer

Corpo

Status do terminal.

  • 0: normal.
  • 1: congelado.

Valor padrão: 0.

Códigos de status

Tabela 3 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 4 Parâmetros de resposta

Parâmetro

Tipo

Descrição

account

String

Conta embutida do terminal físico.

country

String

País ou região a que o número de telemóvel pertence.

deptCode

String

Código do departamento.

deptName

String

Nome do departamento.

deptNamePath

String

Caminho do nome do departamento.

description

String

Descrição do terminal.

email

String

Endereço de e-mail.

model

String

Modelo do dispositivo. O valor é um tipo enumerado. Atualmente, apenas os terminais físicos da série TE são suportados. Você pode obter os modelos de terminal usando a API em Obtenção de todos os modelos de terminal.

name

String

Nome do dispositivo.

number

String

Número SIP vinculado ao terminal.

phone

String

Número de celular.

prjCodeMode

Integer

Modo de geração de código de projeção.

  • 0: modo automático.

    Nesse modo, a complexidade do código é controlada com base no endereço IP informado na mensagem. Para um endereço IP privado, um código de projeção simples é gerado. Para um endereço IP público, um código de projeção complexo é gerado.

  • 1: modo simples.
  • 2: modo complexo.

sn

String

SN de terminal. O valor pode conter apenas números, letras e sublinhados (_).

status

Integer

Status do terminal.

  • 0: normal.
  • 1: congelado.

type

String

Tipo de terminal, que é usado para distinguir terminais desenvolvidos pela Huawei ou de terceiros.

Exemplo de solicitação

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

{
    "model": "TE20",
    "name": "test20",
    "deptCode": "1",
    "phone": "+86**********",
    "email": "****@huawei.com",
    "sn": "asdasfscasd",
    "country": "chinaPR"
}

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: 164
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 65c132ec8939a66775df1382e7d35fc9

{
    "name": "test20",
    "type": "TE",
    "model": "TE20",
    "sn": "asdasfscasd",
    "account": "df8bce2178294683bb83a4985fef7165",
    "number": "+991118029589",
    "prjCodeMode": 0,
    "deptCode": "1",
    "deptName": "wangyue",
    "deptNamePath": "wangyue",
    "phone": "+86***********",
    "country": "chinaPR",
    "email": "****@huawei.com",
    "description": 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: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"model": "TE20","name": "test20","deptCode": "1","phone": "+86**********","email": "****@huawei.com","sn": "asdasfscasd","country": "chinaPR"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device