Adición de una terminal
Descripción
Esta API es utilizada por un administrador de empresa para agregar un terminal duro. Los terminales duros incluyen DP300, serie HUAWEI Bar, HUAWEI Board y serie TE.
SLA
Tasa de éxito de solicitudes: > 99.99%
Retardo de solicitud TP99: 95 ms
Depuración
Puede depurar esta API en Explorador de API.
Prototipo
Método de solicitud |
POST |
---|---|
Direccion de solicitud |
/v1/usg/dcs/corp/device |
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
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 el chino (predeterminado) y en-US para el inglés. |
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 de departamento. El valor predeterminado es el departamento root. Valor predeterminado: 1. maxLength: 32 minLength: 1 |
description |
No |
String |
Body |
Descripción del terminal. maxLength: 128 minLength: 0 |
|
No |
String |
Body |
Formato de dirección de correo electrónico unificado. maxLength: 255 minLength: 0 |
model |
Sí |
String |
Body |
Modelo del dispositivo. El valor es un tipo enumerado. Actualmente, solo se admiten las series TE y algunos terminales duros de terceros. Puede obtener los modelos de terminal usando la API en Obtención de todos los modelos de terminal. maxLength: 128 minLength: 1 |
name |
Sí |
String |
Body |
Nombre de terminal, que se puede personalizar. Se recomienda establecer este parámetro en una ubicación específica para facilitar su identificación. 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 teléfono 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. maxLength: 32 minLength: 0
NOTA:
Se debe especificar el número de teléfono móvil o la dirección de correo electrónico. |
prjCodeMode |
No |
Integer |
Body |
Modo de generación de código de proyección. Valor predeterminado: 0.
|
sendNotify |
No |
string |
Body |
Si desea enviar notificaciones por correo electrónico y SMS.
maxLength: 32 minLength: 0 |
sn |
No |
String |
Body |
Terminal SN. El valor solo puede contener números, letras y guiones bajos (_). maxLength: 30 minLength: 1 |
status |
No |
Integer |
Body |
Estado de terminal.
Valor predeterminado: 0. |
Códigos de estado
Código de estado de HTTP |
Descripción |
---|---|
200 |
Operación exitosa. |
400 |
Parámetros no válidos |
401 |
La autenticación no se realiza o falla. |
403 |
Permisos insuficientes. |
500 |
Excepción del servidor. |
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
account |
String |
Cuenta incorporada del terminal duro. |
country |
String |
|
deptCode |
String |
Código de departamento. |
deptName |
String |
Nombre del departamento. |
deptNamePath |
String |
Ruta del nombre del departamento. |
description |
String |
Descripción del terminal. |
|
String |
Dirección de correo electrónico. |
model |
String |
Modelo del dispositivo. El valor es un tipo enumerado. Actualmente, solo se admiten terminales duros de la serie TE. Puede obtener los modelos de terminal usando la API en Obtención de todos los modelos de terminal. |
name |
String |
Nombre del dispositivo. |
number |
String |
Número SIP enlazado a la terminal. |
phone |
String |
Número móvil. |
prjCodeMode |
Integer |
Modo de generación de código de proyección.
|
sn |
String |
Terminal SN. El valor solo puede contener números, letras y guiones bajos (_). |
status |
Integer |
Estado de terminal.
|
type |
String |
Tipo de terminal, que se utiliza para distinguir los terminales desarrollados por Huawei o de terceros. |
Solicitud de ejemplo
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" }
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: 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 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 el 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: 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