跳到主要内容

获取角色成员

调用本接口,获取某角色的成员


权限说明

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

请求

**请求方式:**GET

**请求地址:**https://api.qingflow.com/role/:roleId/user(公有云版本)

请求地址中:roleId为需要替换的变量,根据实际获取值更新,示例如下:

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

1

JavaScript

其他版本请求地址:

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

专有轻流:http(s)://xxx.xx(自有域名)/openApi/role/:roleId/user

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

参数必须说明
roleId角色id,可通过获取角色列表接口获取

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

2.3 请求头(Header)

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

返回

3.1 返回体

参数必含类型说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
questionRelations关联的设置,这里没用
resultobject返回结果
userListarray
areaCodestring
beingActiveboolean用户的激活状态
beingDisabledboolean是否禁用成员
customDepartmentarray自建部门id列表(仅企业微信/钉钉/飞书等特殊工作区适用)
customRolearray自建角色id列表(仅企业微信/钉钉/飞书等特殊工作区适用)
departmentarray部门id列表
emailstring邮箱
headImgstring头像
mobileNumstring手机号
namestring用户名
rolearray角色id列表
userIdstring用户的userId

3.2 返回体示例

{
"errCode": 0,
"errMsg": null,
"questionRelations": [],
"result": {
"leaderIds": [],
"userList": [
{
"areaCode": "86",
"beingActive": true,
"beingDisabled": false,
"customDepartment": [],
"customRole": [],
"department": [],
"email": "haeng@exiao.tech",
"headImg": "https://file.qingflow.com/uploads/file/b5696-70be-4f21-b8a-c5aae9b.jpg",
"mobileNum": "18083474944",
"name": "韩成",
"optionId": 819146,
"role": [
73246468
],
"userId": "819146"
},
{
"areaCode": "86",
"beingActive": true,
"beingDisabled": false,
"customDepartment": [],
"customRole": [],
"department": [],
"email": "caetue@exiao.tech",
"headImg": "https://file.qingflow.com/uploads/file/165d-ae6f-4b5c-86-ee7763a7.jpg",
"mobileNum": "13137443052",
"name": "snow",
"optionId": 838142,
"role": [
73246468
],
"userId": "838142"
}
]
}
}

注意事项

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