接口描述
描述:获取企业用户列表,支持高级搜索,企微企业不支持此接口。目前暂不支持 OAuth2.0 鉴权访问。
请求方式:GET
自建应用权限点:查看企业用户,管理企业用户。
接口请求域名:
https://api.meeting.qq.com/v1/users/advance/list
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作者 ID。 |
operator_id_type | 是 | Integer | 操作者 ID 类型。 |
pos | 否 | String | 分页获取用户列表的查询起始位置值。当企业用户较多时,建议使用此参数进行分页查询,避免查询超时。此参数为非必选参数,默认值为空,从头开始查询。 设置每页返回的数量,请参考参数“size”的说明。查询返回输出参数“has_remaining”为 true,表示人数较多,需要继续查询。返回参数“next_pos”的值即为下一次查询的 pos 的值。多次调用该查询接口直到输出参数“has_remaining”值为 false。 |
size | 否 | Integer | 目前每页支持最大100条。 |
status | 否 | Integer | 账号状态。 1:正常 3:未激活 4:禁用 |
user_account_type | 否 | Integer | 账号类型。 1:高级 2:免费 |
enable_ai_account | 否 | Boolean | 是否有 AI 账号能力。 true:有 false:无 |
department_id | 否 | String | 指定拉取的部门信息,不传则拉取全企业,需有指定范围的管理权限。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
has_remaining | Boolean | 是否还需要继续拉取。 |
next_pos | String | 下一次查询 pos 位置。 |
users | User 对象数组 | 用户列表。 |
User 对象
参数名称 | 参数类型 | 参数描述 |
userid | String | 用户 userid。 |
uuid | String | 用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。 |
username | String | 用户 name。 |
area | String | 手机区号。 |
update_time | String | 更新时间。 |
avatar_url | String | 用户图像地址。 |
phone | String | 手机号。 |
email | String | 邮箱。 |
status | String | 账号状态: 1:正常 2:注销 3:未激活 4:禁用 5:预注册 |
staff_id | String | 员工工号。 |
job_title | String | 员工职位。 |
entry_time | String | 入职时间。 |
role_name | String | 角色名称。 |
role_code | String | 角色类型。 |
department_list | DepartmentInfo 对象数组 | 用户部门信息。 |
account_version | Integer | 账号版本。
0:其他
1:商业版
2:企业版
3:教育版 |
user_account_type | Integer | 账号类型。
1:高级账号(企业版/教育版)
2:免费账号(企业版/教育版)
3:免费账号100方 (商业版)
4:高级账号300方(商业版)
5:高级账号500方(商业版)
6:高级账号1000方(商业版)
7:高级账号2000方(商业版)
8:高级账号100方(商业版) |
enable_ai_account | Boolean | 是否有 AI 账号能力。 true:有 false:无 教育版/企业版存在有 AI 账号,商业版都具有 AI 能力,其余为 false。 |
ai_account_type | Integer | AI 账号类型。
0:无账号
1:购买版
2:赠送版 |
phone_status | Integer | 手机号验证状态。 0:未知 1:已验证 2:未验证 |
DepartmentInfo 对象
参数名称 | 参数类型 | 参数描述 |
department_id | String | 部门 ID。 |
department_name | String | 部门名称。 |
is_main | Boolean | 是否是主部门。 |
department_full_name | String | 部门全路径。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 550000 | 请求超时,请稍后再试。 |
400 | 500125 | IP 来源不在应用设置的 IP 白名单中。 |
500 | 500060 | 当前企业不支持该功能。 |
400 | 500055 | operator_id 不存在。 |
400 | 500132 | 查询用户列表失败,该 operator_id 没有权限。 |
500 | 41 | 网络错误,请稍后重试。 |
示例
输入示例
GET https://api.meeting.qq.com/v1/users/advance/list?operator_id_type=1&operator_id=testuser
输出示例
{"has_remaining": false,"next_pos": "","users": [{"area": "86","update_time": "2020-04-21 18:01:29","avatar_url": "","phone": "","userid": "9527","email": "","username": "testusername","status": "1","uuid": "WM4Fs4Th56ogU13JiK","role_name": "管理员","role_code": "MANAGER_ROLE","account_version":2,"user_account_type":1,"enable_ai_account":true,"ai_account_type":1,"department_list": [{"department_id": "674da5****************b9e938208e","department_name": "有用户且有子部门的部门"}],"phone_status":1}]}