Help Center/ Meeting/ Server API Reference/ Hard Terminal Management/ Modifying a Terminal
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Terminal

Description

This API is used by an enterprise administrator to modify a professional meeting terminal.

To modify an IdeaHub, SmartRooms, or smart TV, call the API for Modifying a User.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/usg/dcs/corp/device/{sn}

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

sn

Yes

String

Path

Terminal SN. The value can contain only numbers, letters, and underscores (_).

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Request-Id

No

String

Header

Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

Accept-Language

No

String

Header

Language. Values: zh-CN for Chinese (default) and en-US for English.

country

No

String

Body

Country or region that the mobile number belongs to.

Default value: chinaPR.

deptCode

No

String

Body

Department code. The default value is the root department code.

Default value: 1.

description

No

String

Body

Terminal description.

maxLength: 128

minLength: 0

email

No

String

Body

Unified email address format.

name

No

String

Body

Terminal name. You are advised to set this parameter to a specific location.

maxLength: 64

minLength: 0

phone

No

String

Body

Mobile number, which must contain the country code.

For example, a mobile number in Chinese mainland is +86xxxxxxxxxxx. This parameter is combined with the country parameter.

The mobile number can contain only numbers.

NOTE:

The mobile number or email address must be specified.

prjCodeMode

No

Integer

Body

Projection code generation mode.

  • 0: automatic mode.

    In this mode, the code complexity is controlled based on the IP address reported in the message. For a private IP address, a simple projection code is generated. For a public IP address, a complex projection code is generated.

  • 1: simple mode.
  • 2: complex mode.

status

No

Integer

Body

Terminal status.

  • 0: normal.
  • 1: frozen.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

None

Example Request

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

{
    "name": "test",
    "deptCode": "1",
    "email": "test@huawei.com",
    "country": "chinaPR",
    "description": "test",
    "status": 0
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 143
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 88007a3bf4d6478e530b09589582f26f

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF'  -d '{"model": "TE20","name": "test","deptCode": "1","email": "test@huawei.com","country": "chinaPR","description": "test","status": 0}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/asdasfscasd
Parent topic: Hard Terminal Management