主頁(yè) > 服務(wù)與支持 > 開發(fā)平臺(tái) > 服務(wù)端API參考 > 查詢企業(yè)通訊錄 查詢企業(yè)通訊錄
更新時(shí)間:2019-11-20
通過該接口查詢?cè)撈髽I(yè)的通訊錄。
請(qǐng)求方法 |
POST |
---|---|
請(qǐng)求地址 |
/rest/usg/abs/v1/user/_search |
傳輸協(xié)議 |
HTTPS |
參數(shù) |
是否必須 |
類型 |
位置 |
描述 |
---|---|---|---|---|
Authorization |
是 |
String |
Header |
授權(quán)令牌。將執(zhí)行鑒權(quán)響應(yīng)的accessToken進(jìn)行Base64轉(zhuǎn)碼操作。 樣例:Basic Base64(accessToken) |
pageIndex |
否 |
Integer |
Body |
搜索的開始頁(yè),從1開始計(jì)數(shù)。 默認(rèn)值:1 |
pageSize |
否 |
Integer |
Body |
搜索的頁(yè)長(zhǎng)。 默認(rèn)值:15 |
searchKey |
否 |
String |
Body |
搜索的關(guān)鍵字。 |
deptCode |
否 |
String |
Body |
部門編碼。 長(zhǎng)度: 0-32位。 |
querySubDept |
否 |
Boolean |
Body |
是否查詢子部門下的用戶。 默認(rèn)值:true |
searchScope |
否 |
Integer |
Body |
默認(rèn)值:2 |
參數(shù) |
類型 |
描述 |
---|---|---|
returnCode |
String |
業(yè)務(wù)返回碼。 |
returnDesc |
String |
返回描述。 |
achievementTime |
String |
響應(yīng)產(chǎn)生時(shí)間。 |
requestId |
String |
請(qǐng)求唯一標(biāo)識(shí)。 |
data |
查詢企業(yè)通訊錄信息。 |
參數(shù) |
類型 |
描述 |
---|---|---|
pageIndex |
Integer |
頁(yè)面起始頁(yè)。 |
pageSize |
Integer |
頁(yè)面大小。 |
totalCount |
Integer |
總數(shù)量。 |
data |
UserDTO[0..*] |
查詢結(jié)果。 |
參數(shù) |
類型 |
描述 |
---|---|---|
id |
String |
用戶ID。 |
statusCode |
Integer |
查詢用戶詳情時(shí), 根據(jù)不同情況,響應(yīng)不同。
|
account |
String |
用戶賬號(hào)。 |
name |
String |
用戶名。 |
englishName |
String |
英文名。 |
|
String |
郵箱。 |
phone |
String |
用戶手機(jī)。 |
deptName |
String |
用戶部門。 |
number |
String |
用戶號(hào)碼。 |
updateTime |
String |
用戶信息最后更新時(shí)間。 |
isHardTerminal |
Boolean |
是否為硬終端。 |
vmrId |
String |
用戶vmr會(huì)議室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 -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