腾讯会议
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>腾讯会议>开放平台文档>服务端 API>REST APIs>用户管理>获取用户详情

获取用户详情

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

我的收藏

本页目录：

通过 userid 获取用户详情

接口描述

描述：使用 userid 获取企业用户详情。企业 secret 鉴权用户可获取该用户所属企业下的用户详情，暂不支持 OAuth2.0 鉴权用户通过 userid 查询用户详情。
请求方式：GET
自建应用权限点：查看企业用户，管理企业用户。
接口操作者权限点：查看企业通讯录 、查看/编辑角色 、 查看/编辑资源，可登录管理后台查看。
接口请求域名：
https://api.meeting.qq.com/v1/users/{userid}?operator_id={operator_id}&operator_id_type={operator_id_type}


输入参数

以下请求参数列表仅列出了接口请求参数，HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
参数名称
必选
参数类型
参数描述
userid
是
String
调用方用于标示用户的唯一 ID（企业内部请使用企业唯一用户标识）。
企业唯一用户标识说明：
1：企业对接 SSO 时使用的员工唯一标识 ID。
2：企业调用创建用户接口时传递的 userid 参数。
operator_id
是
string
操作者ID
operator_id_type
是
integer
操作者ID类型，1：userid

输出参数

参数名称
参数类型
参数描述
username
String
用户昵称。
update_time
String
更新时间，格式：yyyy-MM-dd HH:mm:ss。
status
String
用户状态：
1：正常
2：注销
3：未激活
4：禁用
5：预注册
email
String
邮箱地址。
avatar_url
String
头像地址。
account_type
Integer
0：个人免费版
5：由企业微信创建的企业
其他值均为会议付费版本。
phone
String
企业员工手机号码。
userid
String
调用方用于标示用户的唯一 ID（例如企业用户可以为企业账户英文名、个人用户可以为手机号等）。
uuid
String
用户身份 ID（腾讯会议颁发的用于开放平台的唯一用户 ID）。
area
String
地区编码（国内默认86）。
staff_id
String
员工工号。
job_title
String
员工职位。
entry_time
String
入职时间。
role_name
String
角色名称。
role_code
String
角色类型。
department_list
部门信息对象数组
用户部门信息。
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：未验证

部门对象

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

错误码列表

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

示例

输入示例

GET https://api.meeting.qq.com/v1/users/9527?operator_id=KM4Ss4Th09ogUw1JiK&operator_id_type=1

输出示例

{
    "area": "86",
    "update_time": "2020-04-21 18:01:29",
    "phone": "13000000000",
    "userid": "9527",
    "email": "",
    "username": "testusername",
    "status": "1",
    "uuid": "WM4Fs4Th56ogU13JiK",
    "job_title": "developer",
    "staff_id": "6666",
    "entry_time": "2021-08-09",
    "role_name": "普通成员",
    "role_code": "NORMAL_ROLE",
    "account_version":2,
    "enable_ai_acccount":true,
    "user_account_type":1,
    "phone_status":1,
    "ai_account_type":1,
    "department_list": [{
        "department_id": "e3ce****************4de921fc2c2d",
        "department_name": "主部门"
    }]
}

通过 uuid 获取用户详情（不推荐）

接口描述

描述：使用 uuid 获取企业用户详情。企业 secret 鉴权用户可获取该用户所属企业下的用户详情，暂不支持 OAuth2.0 鉴权访问。
请求方式：GET
自建应用权限点：查看企业用户，管理企业用户。
接口请求域名：
https://api.meeting.qq.com/v1/users?uuid={uuid}&operator_id={operator_id}&operator_id_type={operator_id_type}


输入参数

以下请求参数列表仅列出了接口请求参数，HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
参数名称
必选
参数类型
参数描述
uuid
是
String
用户身份 ID（腾讯会议颁发的用于开放平台的唯一用户 ID）。
operator_id
是
string
操作者ID
operator_id_type
是
integer
操作者ID类型，1：userid

输出参数

参数名称
参数类型
参数描述
username
String
用户昵称。
update_time
String
更新时间，格式：yyyy-MM-dd HH:mm:ss。
status
String
用户状态：
1：正常
2：注销
3：未激活
4：禁用
email
String
邮箱地址。
phone
String
企业员工手机号码。
userid
String
调用方用于标示用户的唯一 ID（例如企业用户可以为企业账户英文名、个人用户可以为手机号等）。
uuid
String
用户身份 ID（腾讯会议颁发的用于开放平台的唯一用户 ID）。
area
String
地区编码（国内默认86）。
staff_id
String
员工工号。
job_title
String
员工职位。
entry_time
String
入职时间。
role_name
String
角色名称。
role_code
String
角色类型。
department_list
部门信息对象数组
用户部门信息。
enable_ai_account
Boolean
是否有 AI 账号能力。
true：有
false：无
教育版/企业版存在有 AI 账号，商业版都具有 AI 能力，其余为 false。
ai_account_type
Integer
AI 账号类型。 0：无账号 1：购买版 2：赠送版
phone_status
Integer
手机号验证状态。
0：未知
1：已验证
2：未验证

部门对象

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

错误码列表

状态码
错误码
错误描述
400
190004
参数非法，请对照接口文档检查您的参数。
400
20001
用户不存在。

示例

输入示例

GET https://api.meeting.qq.com/v1/users?uuid=WM4Fs4Th56ogU13JiK&operator_id=KM4Ss4Th09ogUw1JiK&operator_id_type=1

输出示例

{
    "area": "86",
    "update_time": "2020-04-21 18:01:29",
    "phone": "13000000000",
    "userid": "9527",
    "email": "",
    "username": "testusername",
    "status": "1",
    "uuid": "WM4Fs4Th56ogU13JiK",
    "job_title": "developer",
    "staff_id": "6666",
    "entry_time": "2021-08-09",
    "role_name": "普通成员",
    "role_code": "NORMAL_ROLE",
    "enable_ai_account":true,
    "phone_status":1,
    "ai_account_type":1,
    "department_list": [{
        "department_id": "e3ce085****************921fc2c2d",
        "department_name": "主部门"
    }]
}


中国站
文档反馈
文档活动
message-icon联系我们
目录