# auth.checkSessionKey
本接口应在服务器端调用,详细说明参见服务端API。
校验服务器所保存的登录态 session_key
是否合法。为了保持 session_key
私密性,接口不明文传输 session_key
,而是通过校验登录态签名完成。
# 请求地址
GET https://api.weixin.qq.com/wxa/checksession?access_token=ACCESS_TOKEN&signature=SIGNATURE&openid=OPENID&sig_method=SIG_METHOD
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token / cloudbase_access_token | string | 是 | 接口调用凭证 | |
openid | string | 是 | 用户唯一标识符 | |
signature | string | 是 | 用户登录态签名 | |
sig_method | string | 是 | 用户登录态签名的哈希方法,目前只支持 hmac_sha256 |
# 返回值
# Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | ok 请求成功 | |
87009 | invalid signature 签名错误 |
# 调用示例
curl -G 'https://api.weixin.qq.com/wxa/checksession?access_token=OsAoOMw4niuuVbfSxxxxxxxxxxxxxxxxxxx&signature=fefce01bfba4670c85b228e6ca2b493c90971e7c442f54fc448662eb7cd72509&openid=oGZUI0egBJY1zhBYw2KhdUfwVJJE&sig_method=hmac_sha256'
# 返回示例
正确时的返回JSON数据包如下:
{"errcode": 0, "errmsg": "ok"}
错误时的返回JSON数据包如下(示例为签名错误):
{"errcode": 87009, "errmsg": "invalid signature"}