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

分页查询企业管理员

描述

通过该接口分页查询企业管理员。

SLA

请求成功率:>99.99%

TP99请求时延:445ms

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/corp/admin

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

offset

Integer

Query

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

limit

Integer

Query

查询数量。

默认值:10

searchKey

String

Query

搜索条件,支持姓名、手机、邮箱、账号、第三方账号模糊搜索。

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 QueryAdminResultDTO objects

查询企业管理员返回的结果。

表5 QueryAdminResultDTO 参数说明

参数

类型

描述

account

String

用户账号。

adminType

Integer

管理员类型。

0:默认管理员

1:普通管理员

country

String

手机号所属的国家

dept

DeptBasicDTO object

部门基本信息。

email

String

邮箱。

id

String

用户id。

name

String

用户名称。

phone

String

手机号。

表6 DeptBasicDTO 参数说明

参数

类型

描述

corpId

String

企业id。

deptCode

String

部门编码。

deptName

String

部门名称。

deptNamePath

String

部门名称路径。

parentDeptCode

String

父部门编码。

请求消息示例

GET /v1/usg/dcs/corp/admin
Connection: keep-alive
X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U
content-type: application/json
Content-Length: 40
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
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: efd3e53b2d9fa554d11267d5d66ca0bf

{
    "offset": 0,
    "limit": 10,
    "count": 1,
    "data": [
        {
            "id": "ff8080816a024f05016a4e1c2c570a5d",
            "account": "test006",
            "name": "test006",
            "adminType": 1,
            "email": "menmeng1@huawei.com",
            "phone": null,
            "country": null,
            "dept": null
        }
    ]
}

错误码

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

CURL命令示例

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

    相关文档

    相关产品

close