code2session | BossHi开发文档

# code2session

通过 login接口获取到登录凭证 code后，开发者可以通过服务器发送请求的方式获取 session_key 和用户信息

本接口应在服务端调用，调用方法参见如何调用服务端API

# 请求

基本
HTTP URL	hi-open.zhipin.com/open-apis/mina/v2/tokenLoginValidate
HTTP Method	POST
支持的应用类型	自建应用商店应用
权限要求	无

# 请求头

名称	类型	必填	描述
Authorization	string	是	app_access_token `值格式`："Bearer `access_token`" `示例值`："Bearer b-7f1bcd13fc57d46bac21793a18e560" 了解更多请查看：获取与使用access_token
Content-Type	string	是	`固定值`："application/json; charset=utf-8"

# 请求体

参数	类型	必填	说明
code	string	是	登录时获取的 code

# 请求体示例

{
    "code":"zsbje81294359cb54b50b2e1fc5c1234e222"
}

1
2
3

# 响应

# 响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟ open_id	string	用户的 open_id，用于在同一个应用中对用户进行标识
∟ employee_id	string	用户的 user_id ，在职员工在企业内的唯一标识仅当开通以下权限后返回该字段获取用户 user ID仅自建应用
∟ session_key	string	会话密钥
∟ tenant_key	string	用户所在企业唯一标识
∟ access_token	string	user_access_token，用户身份访问凭证
∟ expires_in	long	user_access_token过期时间戳，单位：秒
∟ refresh_token	string	刷新用户 access_token 时使用的 token，过期时间为30天。刷新access_token 接口说明请查看文档

# 响应体示例

{
        "code":0,
        "msg":"success",
        "data":{
            "open_id":"ou_194fcfc5e4b78db556a040ff5e42c0",
            "employee_id":"6c486g",
            "session_key":"e3aeb7df000c835365c630dac91bcf",
            "tenant_key":"59e2b56b268fc3b01UUfB_Do",
            "access_token":"u-r5n3a22db1c50d774665a340e3fd9888f97a",
            "expires_in":1662096655,
            "refresh_token":"r-r5n3a22db1c50d774665a340e3fd9888f97a"
        }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# 错误码

HTTP状态码	错误码	描述	排查建议
200	400	认证失败	检查传参及格式是否有问题
200	10202	access token invalid	检查 access_token 是否过期
200	10213	code appid not match	1. 获取code的应用与该接口的应用必须是同一个应用，请确认是否跨应用调用 2. code 仅能使用一次，请确认是否重复使用或者过期
200	10226	invalid code	code不合法，请检查code是否合法或者过期
200	10228	user to app has no visibility	当前用户没有可见性

← checkSession enterProfile →