更新时间:2022-05-05 GMT+08:00
分享

分页查询终端

描述

企业管理员通过该接口分页查询终端信息。

SLA

请求成功率:>99.99%

TP99请求时延:64ms

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/corp/device

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

offset

Integer

Query

查询偏移量,若超过最大数量,则返回最后一页。

limit

Integer

Query

查询数量。

默认值:10

searchKey

String

Query

搜索条件。支持名称、SN模糊查询。

model

String

Query

终端型号,枚举类型。当前支持TE系列硬件终端,具体的终端类型可以通过获取所有终端类型接口查询。

maxLength:128

minLength:0

deptCode

String

Query

部门编号,默认为根部门。

默认值:1

maxLength:32

minLength:0

enableSubDept

Boolean

Query

是否查询子部门。

默认值:true

X-Access-Token

String

Header

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

X-Request-Id

String

Header

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

Accept-Language

String

Header

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

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

count

Integer

总数量。

limit

Integer

每页显示的条目数量。

默认值:10

offset

Integer

页面起始页,从0开始。

data

Array of QueryDeviceResultDTO objects

终端信息列表。

请求消息示例

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

响应消息示例

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

{
    "offset": 0,
    "limit": 10,
    "count": 1,
    "data": [
        {
            "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
        }
    ]
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device
分享:

    相关文档

    相关产品

关闭导读