API Explorer

名称	类型	IN	必选	描述
Accept-Language	string	header	否	语言参数,默认为中文zh-CN,英文为en-US。
X-Request-Id	string	header	否	请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。
X-Access-Token	string	header	是	Access Token。通过执行App ID鉴权接口返回的accessToken。
searchScope	string	query	否	搜索范围。默认值为ALL。 NORMAL_USER - 查询普通用户。返回普通用户(响应中isHardTerminal=false,type=NORMAL_USER) HARD_TERMINAL - 查询硬终端用户。返回大屏用户(响应中isHardTerminal=false,type=WHITE_BOARD)和硬终端用户(响应中isHardTerminal=true,type=HARD_TERMINAL) ALL - 查询所有用户。
querySubDept	boolean	query	否	是否查询子部门下的用户。默认值:true。
deptCode	string	query	否	部门编码。
searchKey	string	query	否	搜索条件。支持帐号、SIP号码、名称、手机、邮箱模糊搜索。
limit	integer	query	否	查询数量。默认值:10。
offset	integer	query	否	查询偏移量,若超过最大数量,则返回最后一页的数据。默认值:0。

名称	类型	描述
offset	integer	页面起始页,从0开始。
limit	integer	每页显示的条目数量。默认值:10。
count	integer	总数量。
data	Array of UserDTO objects	分页查询企业用户信息。

名称

类型

描述

offset

integer

页面起始页,从0开始。

limit

integer

每页显示的条目数量。默认值:10。

count

integer

总数量。

data

Array of UserDTO objects

分页查询企业用户信息。

名称	类型	描述
id	string	用户ID。
statusCode	integer	查询用户详情时, 根据不同情况,响应不同。 0: 查询成功且用户信息有变化, 响应会把新的信息都返回回去 1 :查询成功且用户信息没有变化,响应只会返回用户ID 2 :用户不存在 3 :无权限查询这个用户
account	string	用户帐号。
name	string	用户名。
englishName	string	英文名。
email	string	邮箱地址。
phone	string	用户手机。
deptName	string	用户部门。
number	string	用户SIP号码。
updateTime	long	用户信息最后更新时间。
isHardTerminal	boolean	是否为硬终端。该参数将被废弃,请勿使用。
vmrId	string	用户虚拟会议室ID。
signature	string	用户签名。
title	string	职位。
description	string	描述信息。
hidePhone	boolean	是否隐藏手机号(如果为true,其他人查询该用户时,不会返回该用户的手机号。自己查自己是可见的)
type	string	类型: NORMAL_USER=普通用户 HARD_TERMINAL=硬终端用户 WHITE_BOARD=第三方白板 HW_VISION_MEMBER=智慧屏
deptCodes	Array of strings	部门编码列表。

名称

类型

描述

string

用户ID。

statusCode

integer

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

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

account

string

用户帐号。

name

string

用户名。

englishName

string

英文名。

string

邮箱地址。

phone

string

用户手机。

deptName

string

用户部门。

number

string

用户SIP号码。

updateTime

long

用户信息最后更新时间。

isHardTerminal

boolean

是否为硬终端。

该参数将被废弃,请勿使用。

vmrId

string

用户虚拟会议室ID。

signature

string

用户签名。

title

string

职位。

description

string

描述信息。

hidePhone

boolean

是否隐藏手机号(如果为true,其他人查询该用户时,不会返回该用户的手机号。自己查自己是可见的)

type

string

类型:

NORMAL_USER=普通用户
HARD_TERMINAL=硬终端用户
WHITE_BOARD=第三方白板
HW_VISION_MEMBER=智慧屏

deptCodes

Array of strings

部门编码列表。

{ "offset": 0, "limit": 5, "count": 1, "data": [ { "account": "Zhangsan@example.com", "name": "张三", "englishName": "Zhangsan", "email": "zhangshan@example.com", "phone": "177****0476", "deptName": "cloudcore", "number": "+99111283523475338", "updateTime": 1554268817303, "isHardTerminal": false, "vmrId": "912992631", "signature": "张三的签名信息", "title": "Project Manager", "description": "张三的备注信息", "type": "NORMAL_USER", "deptCodes": [ "1" ] } ] }

本文导读