Skip to content

获取 user_access_token(v1 版本,仅字节)

Error: 本接口已成为历史版本,不推荐使用。请使用最新版本:获取 user_access_token

Warning: 2024年9月19日起,字节内新创建的企业自建应用将默认无法通过「获取 user_access_token」接口获取 refresh_token,需在应用开发者后台安全设置中开启「刷新 user_access_token」开关后方可正常获取和刷新。9月19日前创建的企业自建应用暂不受影响,可通过原接口直接获取和刷新。

根据登录预授权码 code 获取 user_access_token

Tip: 本接口用于网页应用免登录应用场景,小程序应用获取 user_access_token 的方法,请参考小程序应用提供的 code2session 接口。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/authen/v1/access_token
HTTP MethodPOST
接口频率限制特殊频控
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee:readonly 获取用户受雇信息 contact:user.email:readonly 获取用户邮箱信息 contact:user.employee_id:readonly 获取用户 user ID contact:user.phone:readonly 获取用户手机号

请求头

名称类型必填描述
Authorizationstringapp_access_token 值格式:"Bearer access_token" 示例值:"Bearer a-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

请求体

名称类型必填描述
grant_typestring授权类型,固定值
示例值:"authorization_code"
codestring登录预授权码,调用获取登录预授权码接口获取
示例值:"xMSldislSkdK"

请求体示例

json
{
    "grant_type": "authorization_code",
    "code": "xMSldislSkdK"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
datauser_access_token_info-
  └ access_tokenstringuser_access_token,用于获取用户资源
  └ token_typestringtoken 类型
  └ expires_inintaccess_token 的有效期,单位: 秒
  └ namestring用户姓名
  └ en_namestring用户英文名称
  └ avatar_urlstring用户头像
  └ avatar_thumbstring用户头像 72x72
  └ avatar_middlestring用户头像 240x240
  └ avatar_bigstring用户头像 640x640
  └ open_idstring用户在应用内的唯一标识
  └ union_idstring用户统一ID
  └ emailstring用户邮箱
字段权限要求contact:user.email:readonly 获取用户邮箱信息
  └ enterprise_emailstring企业邮箱,请先确保已在管理后台启用飞书邮箱服务
字段权限要求contact:user.employee:readonly 获取用户受雇信息
  └ user_idstring用户 user_id
字段权限要求contact:user.employee_id:readonly 获取用户 user ID
  └ mobilestring用户手机号
字段权限要求contact:user.phone:readonly 获取用户手机号
  └ tenant_keystring当前企业标识
  └ refresh_expires_inintrefresh_token 的有效期,单位: 秒
  └ refresh_tokenstring刷新用户 access_token 时使用的 token
  └ sidstring用户当前登录态session的唯一标识,为空则不返回

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "access_token": "u-Q7JWnaIM_kRChuLfreHmpArjOEayt.5XUBJcZr.V0Gst4FdQCtvrd9sAViLXQnQgkpL19brGOjKZQTxb",
        "token_type": "Bearer",
        "expires_in": 7140,
        "name": "zhangsan",
        "en_name": "Three Zhang",
        "avatar_url": "www.feishu.cn/avatar/icon",
        "avatar_thumb": "www.feishu.cn/avatar/icon_thumb",
        "avatar_middle": "www.feishu.cn/avatar/icon_middle",
        "avatar_big": "www.feishu.cn/avatar/icon_big",
        "open_id": "ou_caecc734c2e3328a62489fe0648c4b98779515d3",
        "union_id": "on_d89jhsdhjsajkda7828enjdj328ydhhw3u43yjhdj",
        "email": "zhangsan@feishu.cn",
        "enterprise_email": "demo@mail.com",
        "user_id": "5d9bdxxx",
        "mobile": "+86130002883xx",
        "tenant_key": "736588c92lxf175d",
        "refresh_expires_in": 2591940,
        "refresh_token": "ur-oQ0mMq6MCcueAv0pwx2fQQhxqv__CbLu6G8ySFwafeKww2Def2BJdOkW3.9gCFM.LBQgFri901QaqeuL",
        "sid": "AAAAAAAAAANjgHsqKEAAEw=="
    }
}

错误码

HTTP状态码错误码描述排查建议
20020001Invalid request. Please check request param请检查请求参数
20020007Failed to generate a user access token. Please try again生成失败,请检查参数是否有效,重试
20020008User not exist用户不存在,换有效帐号
20020009Tenant does not install app租户没有安装app,请联系租户管理员安装
20020021User resigned用户离职,请使用有效帐号
20020022User frozen用户冻结,请使用有效帐号
20020023User not registered用户未注册,请使用有效帐号
20020024App id in user_access_token or refresh_token diff with app id in app_access_token or tenant_access_token. Please keep the app id consistent请检查生成两个token的app是否为同一个
20020025Lack of app_id or app_secret in request缺失app_id或app_secret,请检查参数
20020028Invalid app id无效app_id,请检查参数
50020050System error系统错误,请重试

内容来源:飞书开放平台 · 自动爬取整理