查询部门用户列表

最近更新时间:2024-11-04 09:30:42

我的收藏

接口描述

描述:查询企业部门用户列表,仅企业下具有部门查询权限和查询用户列表权限的用户可查询部门用户列表。不支持 OAuth 2.0鉴权访问。
请求方式:GET
自建应用权限点:查看企业用户,管理企业用户。
接口操作者权限点:查看企业通讯录 、查看/编辑角色 、 查看/编辑资源,可登录 管理后台 查看。
接口请求域名
https://api.meeting.qq.com/v1/departments/{departmentId}/users?userid={userid}&page={page}&page_size={page_size}


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
userid
String
接口操作者 userid。
page
Integer
分页,默认为1,最小值为1。
page_size
Integer
分页大小,默认为20,取值范围[1,20]。

输出参数

成功输出以下字段,失败则返回 错误码 和错误信息。
参数名称
参数类型
参数描述
total_page
Integer
数据总页数。
total_count
Integer
数据总条数。
current_size
Integer
当前页实际大小。
current_page
Integer
当前页。
users
Users 对象数组
用户对象列表。

Users 对象

参数名称
参数类型
参数描述
userid
String
企业用户 userid。
uuid
String
用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。
user_name
String
企业用户 name。
role_name
String
角色名称。
role_code
String
角色类型。
area
String
手机区号。
phone
String
手机号。
email
String
邮箱。
status
Integer
账号状态:
1:正常
2:删除
3:未激活
4:禁用
staff_id
String
工号。
job_title
String
职位。
entry_time
String
入职时间。
department_id
String
部门 ID。
department_name
String
部门名称。

错误码列表

状态码
错误码
错误描述
500
190444
用户无部门操作权限。场景:
1. 用户无编辑部门信息权限
2. 用户无查看部门信息权限
500
20000
该企业部门信息不存在。
400
190004
参数非法,请对照接口文档检查您的参数。

示例

输入示例

GET
https://api.meeting.qq.com/v1/departments/b3295f********f3f58843532c689536/users?userid=meeting4548079

输出示例

{
"total_count": 1,
"total_page": 1,
"current_page": 1,
"current_size": 1,
"users": [{
"userid": "department-test",
"uuid": "WMYP3********MnGQt",
"user_name": "department-tester",
"role_name": "普通成员",
"role_code": "NORMAL_ROLE",
"area": "86",
"phone": "184****8545",
"email": "119****594@qq.com",
"status": 1,
"staff_id": "9999",
"job_title": "departmnt-test",
"entry_time": "2021-08-09T00:00:00+08:00",
"department_id": "b3295fd1********f58843532c689536",
"department_name": "hay***-子部门-01"
}]
}