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

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 查询企业通讯录 查询企业通讯录

入门使用

查询企业通讯录

更新时间：2019-11-20

描述

通过该接口查询该企业的通讯录。

接口原型

表1 接口原型

请求方法

POST

请求地址

/rest/usg/abs/v1/user/_search

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

是

String

Header

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

样例：Basic Base64(accessToken)

pageIndex

否

Integer

Body

搜索的开始页，从1开始计数。

默认值：1

pageSize

否

Integer

Body

搜索的页长。

默认值：15

searchKey

否

String

Body

搜索的关键字。

deptCode

否

String

Body

部门编码。

长度： 0-32位。

querySubDept

否

Boolean

Body

是否查询子部门下的用户。

默认值：true

searchScope

否

Integer

Body
  • 0：查询普通用户
  • 1：查询终端用户
  • 2：查询所有用户

默认值：2

响应参数

表3 参数说明

参数

类型

描述

returnCode

String

业务返回码。

returnDesc

String

返回描述。

achievementTime

String

响应产生时间。

requestId

String

请求唯一标识。

data

UserPage

查询企业通讯录信息。
表4 UserPage 数据结构

参数

类型

描述

pageIndex

Integer

页面起始页。

pageSize

Integer

页面大小。

totalCount

Integer

总数量。

data

UserDTO[0..*]

查询结果。
表5 UserDTO 数据结构

参数

类型

描述

id

String

用户ID。

statusCode

Integer

查询用户详情时, 根据不同情况，响应不同。

  • 0： 查询成功且用户信息有变化， 响应会把新的信息都返回回去
  • 1 ：查询成功且用户信息没有变化，响应只会返回用户ID
  • 2 ：用户不存在
  • 3 ：无权限查询这个用户

account

String

用户账号。

name

String

用户名。

englishName

String

英文名。

email

String

邮箱。

phone

String

用户手机。

deptName

String

用户部门。

number

String

用户号码。

updateTime

String

用户信息最后更新时间。

isHardTerminal

Boolean

是否为硬终端。

vmrId

String

用户vmr会议室ID。

signature

String

用户签名。

title

String

职位。

description

String

描述信息。

请求消息示例

POST /rest/usg/abs/v1/user/_search
Connection: keep-alive
Authorization: Basic MjhzcVM3czVkRjZNTzFMVDF0Q0dHc2pwRGpBWnNyR3ZJ
Content-Type: application/json
Content-Length: 102
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "pageIndex": 1,
    "pageSize": 15,
    "searchKey": "",
    "deptCode": "1",
    "searchScope": 0
}
 

响应消息示例

HTTP/1.1 200 
Date: Sun, 05 May 2019 09:05:37 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Expires: Thu, 01 Jan 1970 00:00:00 GMT
http_proxy_id: 1fd3a76bc862c7bc7f7c9b09bea87647
Server: api-gateway
X-Request-Id: 7f3dc39fd1af5f1f274641d46ed720ba

{
    "returnCode": "000000000",
    "returnMessage": "I18n.SYSTEM.SUCCESS",
    "achievementTime": "2019-05-05 08:55:03.202",
    "requestId": "fac9448e642fa5516229cf3afcbd3a29",
    "data": 
    {
        "pageIndex": 1,
        "totalCount": 10,
        "pageSize": 15,
        "data": [
        {
            "id": "ff8080816933ab4801694865840a00c2",
            "statusCode": null,
            "account": "test01",
            "name": "test01",
            "email": "test01@huawei.com",
            "phone": null,
            "deptName": "huawei01",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1551697806346,
            "isHardTerminal": false
        },
        {
            "id": "ff80808169e79714016a4eab9070248b",
            "statusCode": null,
            "account": "test02",
            "name": "test02",
            "email": "test02@corpnew.com",
            "phone": null,
            "deptName": "huawei01",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1556098027632,
            "isHardTerminal": false
        },
        {
            "id": "ff80808169e794dc016a4ead78840165",
            "statusCode": null,
            "account": "test03",
            "name": "test03",
            "email": "test03@corpnew.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1556098152580,
            "isHardTerminal": false
        },
        {
            "id": "ff80808169e79714016a4eae1b81248e",
            "statusCode": null,
            "account": "test04",
            "name": "test04",
            "email": "test04@corpnew.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1556098194305,
            "isHardTerminal": false
        },
        {
            "id": "ff8080816933ab48016938a3faa00098",
            "statusCode": null,
            "account": "user01",
            "name": "user01",
            "email": "user01@Huawei.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1553764724575,
            "isHardTerminal": false
        },
        {
            "id": "ff8080816933ab48016938b0fc65009b",
            "statusCode": null,
            "account": "user02",
            "name": "user02",
            "email": "user02@huawei.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1553765119969,
            "isHardTerminal": false
        },
        {
            "id": "ff8080816933ab48016947b3401d00af",
            "statusCode": null,
            "account": "user03",
            "name": "user03",
            "email": "user03@huawei.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1553765127725,
            "isHardTerminal": false
        },
        {
            "id": "ff80808169e79714016a33bae22f0104",
            "statusCode": null,
            "account": "user09",
            "name": "user09",
            "email": "user09@huawei.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1555646101846,
            "isHardTerminal": false
        },
        {
            "id": "ff8080816933ab48016957331ee800d0",
            "statusCode": null,
            "account": "user10",
            "name": "user10",
            "email": "user10@huawei.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1551946161896,
            "isHardTerminal": false
        },
        {
            "id": "ff80808169570fea01699502978000be",
            "statusCode": null,
            "account": "user11",
            "name": "user11",
            "email": "user11@huawei.com",
            "phone": null,
            "deptName": "huawei01 ",
            "number": "+8657*******",
            "signature": null,
            "updateTime": 1552983168896,
            "isHardTerminal": false
        }]
    }
}
 

CURL命令示例

curl -k -i -H 'Content-Type: application/json' -X POST -H 'Authorization: Basic NnJTY0Y4OHF1dm8ySGdhNGtPU1ZBNldKemU3MXlUVUx4' -d '{"pageIndex": 1,"pageSize": 15,"searchKey": "","deptCode": "1","searchScope": 0}' https://api.meeting.huaweicloud.com/rest/usg/abs/v1/user/_search