文档首页/ 华为云会议 Meeting/ 服务端API参考/ 硬终端管理/ 专业会议终端管理/ 查询设备状态
更新时间：2024-04-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询设备状态

描述

调用本接口可以查询专业会议终端的状态。

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

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/usg/acs/ap/userstatus

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

否

String

Header

请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。

Accept-Language

否

String

Header

语言参数，默认为中文zh-CN，英文为en-US。

[数组元素]

是

Array of strings

Body

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

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

[数组元素]

Array of UserStatusDTO

设备状态列表
表5 UserStatusDTO数据结构

参数

类型

描述

CallStatus

String

呼叫状态。

0：未上线

1：空闲中

2：使用中

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

Number

String

终端号码。

RegStatus

String

注册状态。

0：已注册

1：未注册

请求消息示例

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*******"
]

响应消息示例

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"
    }
]

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

CURL命令示例

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

相关文档