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

Querying the Terminal Status

Description

This API is used to query the status of a professional meeting terminal.

The professional meeting terminal and the account that initiates the query request must belong to the same enterprise. Otherwise, the authentication fails.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/usg/acs/ap/userstatus

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

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.

[Array element]

Yes

Array of strings

Body

Number of the terminal to query.

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

[Array element]

Array of UserStatusDTO

List of device statuses.
Table 5 UserStatusDTO data structure

Parameter

Type

Description

CallStatus

String

Call status.

  • 0: offline.
  • 1: idle.
  • 2: in use.
  • 3: invalid value for non-meeting hard terminals.

Number

String

Terminal number.

RegStatus

String

Registration status.

  • 0: registered.
  • 1: not registered.

Example Request

POST /v1/usg/acs/ap/userstatus
Connection: keep-alive
X-Access-Token: stbtsadx6U2jBKxODtf3Ylnff5uGZX8mzu1K
content-type: application/json
Content-Length: 40
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131)

[
    "+99*******"
]

Example Response

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
Server: api-gateway
X-Request-Id: a48502799c8d43519ba81502110cf213

[
    {
        "Number": "tel:+991116173924",
        "RegStatus": "0",
        "CallStatus": "1"
    }
]

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 POST -H 'X-Access-Token: stbtsadx6U2jBKxODtf3Ylnff5uGZX8mzu1K' -d '["+99*******"]' https://api.meeting.huaweicloud.com/v1/usg/acs/ap/userstatus
Parent topic: Hard Terminal Management