说明:
账户级接口属于仅账户管理员可以使用的接口,是重量级接口,查询的信息量比较大,访问限制:100次/min。
接口描述
描述:获取账户中的所有用户列表,目前暂不支持 OAuth2.0 鉴权访问。
请求方式:GET
自建应用权限点:查看企业用户,管理企业用户。
接口操作者权限点:查看企业通讯录 、查看/编辑角色 、 查看/编辑资源,可登录 管理后台 查看。
接口请求域名:
https://api.meeting.qq.com/v1/corp/users?page={page}&page_size={page_size}&operator_id={operator_id}&operator_id_type={operator_id_type}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
page_size | 是 | Integer | 分页大小。 |
page | 是 | Integer | 当前页。 |
user_name | 否 | String | 用户名称。 |
userid | 否 | String | 用户 userid。 |
uuid | 否 | String | 用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。 |
status | 否 | Integer | 账号状态: 0:禁用 1:启用 2:未激活 |
role_code | 否 | String | 角色类型。 |
operator_id | 是 | String | 操作者 ID。 |
operator_id_type | 是 | String | 操作者 ID 类型。 1:userid |
输出参数
参数名称 | 参数类型 | 参数描述 |
current_page | Integer | 当前页。 |
current_size | Integer | 当前页实际大小。 |
total_count | Integer | 数据总条数。 |
total_page | Integer | 数据总页数。 |
users | Users 对象数组 | 用户对象列表。 |
Users 对象
参数名称 | 参数类型 | 参数描述 |
userid | String | 企业用户 userid。 |
uuid | String | 用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。 |
user_name | String | 企业用户 name。 |
area | String | 手机区号。 |
update_time | String | 更新时间。 |
avatar_url | String | 用户图像地址。 |
role_name | String | 角色名称。 |
role_code | String | 角色类型。 |
phone | String | 手机号。 |
email | String | 邮箱。 |
status | Integer | 账号状态。 |
departments | Departments 对象数组 | 部门对象列表。 |
enable_ai_account | Boolean | 是否有 AI 账号能力。 true:有 false:无 教育版/企业版存在有 AI 账号,商业版都具有 AI 能力,其余为 false。 |
ai_account_type | Integer | AI 账号类型。
0:无账号
1:购买版
2:赠送版 |
user_account_type | Integer | 账号类型: 1:高级账号 (企业版,教育版) 2:免费账号 (企业版,教育版,商业版) 3:免费账号100方 (商业版) 4:高级账号300方(商业版) 5:高级账号500方(商业版) 6:高级账号1000方(商业版) 7:高级账号2000方(商业版) |
Departments 对象
参数名称 | 参数类型 | 参数描述 |
department_id | String | 部门 ID。 |
department_name | String | 部门 name。 |
department_full_name | String | 部门全称(包含全部上级部门名称,不包含公司名称)。 |
is_main | Boolean | 是否主部门: true:是 false:否 |
示例
输入示例
GET /v1/corp/users?page_size=20&page=1&operator_id=KM4Ss4Th09ogUw1JiK&operator_id_type=1
输出示例
{"total_count":1,"total_page":1,"current_page":1,"current_size":1,"users":[{"userid":"testuser123","uuid":"WMfgHRxxxxx6mcDGtK","user_name":"test123","area":"86","update_time":"2020-09-02 07:29:39","role_name":"超级管理员","role_code":"ADMIN_ROLE","phone":"12365475648","status":1,"enable_ai_account":true,"ai_account_type":1,"departments":[{"id":"123","name":"质量组","full_name":"质量部/质量组","is_main":true}]}]}