# wx.checkSession(Object object)

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：支持
> 
> __小程序插件__：不支持
> 
> __微信 Windows 版__：支持
> 
> __微信 Mac 版__：支持

> 相关文档: [小程序登录](/minigame/dev/guide/open-ability/login.md)、[接口调用频率规范](/minigame/dev/guide/performance/api-frequency.md)

## 功能描述

检查登录态 session_key 是否过期。

session_key 具有唯一性，在使用小程序时，同一用户在同一时刻仅有一个有效的 session_key。

通过 wx.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序，用户登录态越有可能过期。反之如果用户一直在使用小程序，则用户登录态一直保持有效。具体时效逻辑由微信维护，对开发者透明。除了过期失效外，触发获取临时登录凭证 code 的操作（[小程序登录](/minigame/dev/guide/open-ability/login.md) 和 [数据预拉取](/minigame/dev/guide/base-ability/pre-fetch.md)）可能会生成新的登录态session_key，从而使旧的 session_key 被顶替而失效。

开发者可以调用 wx.checkSession 接口检测用户登录态是否过期。**注意，wx.checkSession 的校验对象是最后一次获取 code 操作对应的登录态 session_key**，调用成功说明该 session_key 未过期，调用失败说明 session_key 已过期。如果要校验指定的 session_key 是否有效，可以在开发者服务器后台调用 [checkSessionKey](user-login/checkSessionKey)。

登录态失效后开发者可以再调用 wx.login 获取新的用户登录态。

## 参数

### Object object

| 属性 | 类型 | 默认值 | 必填 | 说明 |
| ---- | ---- | ------ | -------- | ---- |
| success | function |  | 否 | 接口调用成功的回调函数 |
| fail | function |  | 否 | 接口调用失败的回调函数 |
| complete | function |  | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |

## 示例代码

```js
wx.checkSession({
  success () {
    //session_key 未过期，并且在本生命周期一直有效
  },
  fail () {
    // session_key 已经失效，需要重新执行登录流程
    wx.login() //重新登录
  }
})
```