跳到主要内容

获取工作区全部成员

获取工作区全部成员信息


权限说明

公有云专有轻流都可以调用。

「超管accessToken」和「权限组accessToken」都可以调用,「权限组accessToken」须具有通讯录全部成员权限。

请求

**请求方式:**GET

请求地址:https://api.qingflow.com/user

GET https://api.qingflow.com/user

其他版本请求地址:

钉钉版本:https://api.ding.qingflow.com/user

专有轻流:http(s)://自有域名/openApi/user

2.1 参数说明(路径参数):

2.2 参数说明(查询参数):

参数必须说明
pageSize分页大小,必填
pageNum分页页号,必填

2.3 请求头(Header)

参数必须说明
accessToken调用接口凭证。获取方法请查看“文档”

2.4 请求体(Body)

返回

3.1 返回体

参数必含类型说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
resultobject返回结果
pageSizeint分页大小
pageNumint分页页号
resultAmountint成员总数
pageAmountint页总数
resultarray
userIdstring用户的userId
optionIdint
emailstring邮箱
namestring用户名称
areaCodestring区号
mobileNumstring手机号
headImgstring头像
departmentarray部门ID列表
rolearray角色ID列表
customRolearray成员所属自建角色列表(仅企业微信/钉钉/飞书等特殊工作区的专有轻流工作区适用)
customDepartmentarray成员所在自建部门列表(仅企业微信/钉钉/飞书等特殊工作区适用)
beingDisabledboolean是否禁用成员
beingActiveboolean用户的激活状态

3.2 返回体示例

{
"errCode": 0,
"errMsg": null,
"questionRelations": [],
"result": {
"pageAmount": 3,
"pageNum": 1,
"pageSize": 20,
"result": [
{
"areaCode": "86",
"beingActive": true,
"beingDisabled": false,
"customDepartment": [],
"customRole": [],
"department": [],
"email": "@exiao.tech",
"headImg": "https://file.qingflow.com/uploads/file.jpg",
"mobileNum": "12344452143",
"name": "xxx",
"optionId": 111111,
"role": [],
"userId": "111111"
}
],
"resultAmount": 1
}
}

注意事项

1、企微版本公有云工作区,用户名(name参数)返回用户userid