# 重置登录态
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
ResetUserSessionKey
# 功能描述
重置指定的登录态 session_key。为了保持 session_key 私密性,接口不明文传入 session_key,而是通过校验登录态签名完成。
# 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/wxa/resetusersessionkey?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:18
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token | |
openid | string | 是 | 用户唯一标识符 | |
signature | string | 是 | 用户登录态签名 | |
sig_method | string | 是 | 用户登录态签名的哈希方法,目前只支持 hmac_sha256 |
# 返回值
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
openid | string | 用户唯一标识符 |
session_key | string | 重置后的用户登录态 |
# 其他说明
- 重置用户session_key后,原有的session_key会失效。请注意接口调用时机,以免影响用户在小程序中的体验。
- 重置后的session_key会继承原有的session_key的过期时间,重置操作不能为session_key续期。
- 单个小程序appid请求量频率限制为 60000 次 / 分钟。
- 不允许频繁重置同一个用户的登录态。
# 调用示例
示例说明: ResetUserSessionKey请求示例
# 请求数据示例
GET https://api.weixin.qq.com/wxa/resetusersessionkey?access_token=ACCESS_TOKEN&openid=OPENID&signature=SIGNATURE&sig_method=hmac_sha256
# 返回数据示例
{"errcode": 0, "errmsg": "ok", "openid": "xxxxxxx", "session_key": "xxxxxxxx" }
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
45011 | api minute-quota reach limit mustslower retry next minute | API 调用太频繁,请稍候再试 |
87008 | invalid sig_method | |
87007 | session_key is not existd or expired | |
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
87009 | invalid signature | 无效的签名 |
40097 | invalid args | 参数错误 |