wx.login(Object object) | 微信开放文档

以 Promise 风格调用：不支持

小程序插件：支持，需要小程序基础库版本不低于 2.3.1

在小程序插件中使用时，需要在用户信息功能页中获得用户授权或满足一定条件后调用。否则将返回 fail。详见用户信息功能页

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 小程序登录、UnionID 机制说明、接口调用频率规范

# 功能描述

调用接口获取登录凭证（code）。通过凭证进而换取用户登录态信息，包括用户在当前小程序的唯一标识（openid）、微信开放平台账号下的唯一标识（unionid，若当前小程序已绑定到微信开放平台账号）及本次登录的会话密钥（session_key）等。用户数据的加解密通讯需要依赖会话密钥完成。

# 参数

# Object object

属性	类型	必填	说明	最低版本
timeout	number	否	超时时间，单位ms	1.9.90
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

# object.success 回调函数

# 参数

# Object res

属性	类型	说明
code	string	用户登录凭证（有效期五分钟）。开发者需要在开发者服务器后台调用 code2Session，使用 code 换取 openid、unionid、session_key 等信息

# object.fail 回调函数

# 参数

# Object err

属性	类型	说明	最低版本
errMsg	String	错误信息
errno	Number	errno 错误码，错误码的详细说明参考 Errno错误码	2.24.0

# 示例代码

wx.login({
  success (res) {
    if (res.code) {
      //发起网络请求
      wx.request({
        url: 'https://example.com/onLogin',
        data: {
          code: res.code
        }
      })
    } else {
      console.log('登录失败！' + res.errMsg)
    }
  }
})

# wx.login(Object object)

# 功能描述

# 参数

# Object object

# object.success 回调函数

# 参数

# Object res

# object.fail 回调函数

# 参数

# Object err

# 示例代码