腾讯会议
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 腾讯会议 > 开放平台文档 > 服务端 API > REST APIs > 用户管理 > 获取用户列表

获取用户列表

最近更新时间：2024-04-25 11:18:42

我的收藏

本页目录：

接口描述

描述：获取企业用户列表，目前暂不支持 OAuth2.0 鉴权访问。
请求方式：GET
接口请求域名：
https://api.meeting.qq.com/v1/users/list?page={page}&page_size={page_size}

输入参数

以下请求参数列表仅列出了接口请求参数，HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
参数名称
必选
参数类型
参数描述
page
是
Integer
当前页，大于等于1。
page_size
是
Integer
分页大小，最大为20。

输出参数

参数名称
参数类型
参数描述
total_count
Integer
总数。
current_size
Integer
当前页实际大小。
current_page
Integer
当前页数。
page_size
Integer
分页大小。
users
UserInfo 对象数组
数组格式，item 为用户对象。

UserInfo 对象

参数名称
参数类型
参数描述
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方（商业版）

DepartmentInfo 对象

参数名称
参数类型
参数描述
department_id
String
部门 ID。
department_name
String
部门名称。

错误码列表

状态码
错误码
错误描述
400
190004
参数非法，请对照接口文档检查您的参数。
400
190301
请求重放错误，请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成，不能使用和过去五分钟内相同的 timestamp 和 nonce。
400
200001
API 请求头缺失必填字段。
500
10010
用户信息 API 调用网络异常。
500
41
网络错误，请稍后重试。
500
960000
网络错误，请稍后重试。
500
190310
每分钟总接口调用次数超过限制。
500
10012
用户信息 API 调用 mysql 异常。
400
500014
账号无权限。

示例

输入示例

GET https://api.meeting.qq.com/v1/users/list?page=1&page_size=1

输出示例

{
 "total_count": 39,
 "current_size": 1,
 "current_page": 1,
 "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,
    "department_list": [{
        "department_id": "674da5****************b9e938208e",
        "department_name": "有用户且有子部门的部门"
    }]
   }
 ],
 "page_size": 1
}


中国站