# 检验用户授权凭证
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:snsAuth
检验授权凭证(access_token)是否有效
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
openid | string | 是 | OPENID | 用户的唯一标识 |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误描述 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
# 5.1 有效凭证
请求示例
https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
返回示例
{
"errcode":0,
"errmsg":"ok"
}
# 5.2 无效凭证
请求示例
https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
返回示例
{
"errcode":40003,
"errmsg":"invalid openid"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40003 | invalid openid | 不合法的 OpenID ,请开发者确认 OpenID (该用户)是否已关注公众号,或是否是其他公众号的 OpenID |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
服务号 | 移动应用 | 网站应用 |
---|---|---|
仅认证 | ✔ | ✔ |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;