智慧服务，成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 硬终端管理 查询设备状态

入门使用

查询设备状态

更新时间：2019-11-20

描述

调用本接口可以查询硬终端的状态。

硬终端与发起查询请求的帐号需在同一企业下，否则会鉴权失败。

接口原型

表1 接口原型

请求方法

POST

请求地址

/rest/usg/ap/v1/userstatus

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

是

String

Header

授权令牌。将执行鉴权响应的accessToken进行Base64转码操作。

样例：Basic Base64(accessToken)

number

是

String[0..*]

Body

所请求查询的终端的号码。

响应参数

表3 参数说明

参数

类型

描述

returnCode

String

业务返回码。

returnDesc

String

返回描述。

achievementTime

String

响应产生时间。

requestId

String

请求唯一标识。

data

UserStatusDTO

终端设备的状态信息。
表4 UserStatusDTO参数说明

参数

类型

描述

Number

String

终端号码。

RegStatus

String

注册状态。

0：已注册

1：未注册

CallStatus

String

呼叫状态。

0：未上线

1：空闲中

2：使用中

3：非会议硬终端统一的无效值

请求消息示例

POST /rest/usg/ap/v1/userstatus
Connection: keep-alive
Authorization: Basic dVZ5cDdBZG5xdzNlOWRqVUo1ckMyZFptaDZDSzhPYWlQ
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*******"
]
 

响应消息示例

HTTP/1.1 200 
Date: Fri, 12 Apr 2019 07:09:51 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

{
    "returnCode": "000000000",
    "returnMessage": "Success",
    "achievementTime": "2019-08-13 01:40:44.169 UTC",
    "requestId": "a48502799c8d43519ba81502110cf213",
    "data": [
        {
            "Number": "tel:+99*******",
            "RegStatus": "0",
            "CallStatus": "3"
        }
    ]
}
 

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'Authorization: Basic VUVwVU82SWFISU0ySWlKaEdoRllRUXk0MUZnbk00Mkpk' -d '["+99*******"]' https://api.meeting.huaweicloud.com/rest/usg/ap/v1/userstatus