获取用户基本信息

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

我的收藏

接口描述

描述:仅支持 OAuth 2.0鉴权用户获取该企业下 OAuth 2.0应用的用户基本信息。
调用该接口需要三个项权限中的任意一个
VIEW_USER_INFO 查看您的用户详细信息。
MANAGE_USER_INFO 查看和管理您的详细用户信息。
VIEW_USER_BASIC_INFO 查看您的用户基本信息。
请求方式:GET
自建应用权限点:查看企业用户,管理企业用户。
接口操作者权限点:需具备用户列表的查看权限,可登录 管理后台 通过如下路径查看:用户管理 > 用户列表 > 查看权限。
接口请求域名
https://api.meeting.qq.com/v1/users/info/basic


输入参数

HTTP 请求头公共参数参考鉴权方式章节里的公共参数说明:企业自建应用鉴权(JWT)第三方应用鉴权(OAuth)
参数名称
必选
参数类型
参数描述
operator_id
String
操作者 ID,该接口不支持获取 MRA、Rooms、小程序的账号。
operator_id 必须与operator_id_type 配合使用。
根据 operator_id_type 的值,operator_id 代表不同类型。
operator_id_type
Integer
操作者 ID 的类型。
2:openid。

输出参数

参数名称
参数类型
参数描述
username
String
用户昵称。
open_corp_id
String
企业 Open ID,个人用户返回为空。
open_corp_name
String
企业名称,个人用户返回为空。
status
String
用户账号状态:
1:正常
2:注销
3:未激活
4:禁用
5:预注册
avatar_url
String
头像地址。
account_type
Integer
注意:
即将废弃,不建议使用该字段。
0:个人免费版
5:由企业微信创建的企业
其他值均为会议付费版本。
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:未验证

错误码列表

状态码
错误码
错误描述
500
190325
OAuth 权限点校验失败。
400
190004
参数非法,请对照接口文档检查您的参数。
400
20001
用户不存在。

示例

输入示例

GET https://api.meeting.qq.com/v1/users/info/basic?operator_id=KM4Ss4Th09ogUw1JiK&operator_id_type=2

输出示例

{
"username": "testusername",
"open_corp_id": "hiah6xxxxx9787",
"open_corp_name": "腾讯",
"status": "1",
"avatar_url":"https://www.xxx.xxx.xx.xxxxxxxxxxxxxx.png",
"account_version":2,
"user_account_type":1,
"enable_ai_account":true,
"ai_account_type":1
}