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

Querying Terminal Details

Description

This API is used by an enterprise administrator to query details about a professional meeting terminal.

To query details about an IdeaHub, SmartRooms, or smart TV, call the API for Querying User Details.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

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.

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

Table 4 Response parameters

Parameter

Type

Description

account

String

Built-in account of the hard terminal.

country

String

Country or region that the mobile number belongs to.

deptCode

String

Department code.

deptName

String

Department name.

deptNamePath

String

Department name path.

description

String

Terminal description.

email

String

Email address.

model

String

Device model. The value is an enumerated type. Currently, only TE series hard terminals are supported. You can obtain the terminal models using the API in Obtaining All Terminal Models.

name

String

Device name.

number

String

SIP number bound to the terminal.

phone

String

Mobile number.

prjCodeMode

Integer

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.

sn

String

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

status

Integer

Terminal status.

  • 0: normal.
  • 1: frozen.

type

String

Terminal type, which is used to distinguish Huawei-developed or third-party terminals.

Example Request

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

Example Response

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

{
    "name": "test",
    "type": "TE",
    "model": "TE20",
    "sn": "asdasfscasd",
    "account": "df8bce2178294683bb83a4985fef7165",
    "number": "+991118029589",
    "prjCodeMode": 0,
    "deptCode": "1",
    "deptName": "wangyue",
    "deptNamePath": "wangyue",
    "phone": "+86***********",
    "country": "chinaPR",
    "email": "test@huawei.com",
    "description": "test",
    "status": 0
}

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 -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/asdasfscasd
Parent topic: Hard Terminal Management