# 刷新用户授权凭证
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:snsRefreshToken
由于access_token拥有较短的有效期,当access_token超时后,可以使用refresh_token进行刷新,refresh_token有效期为30天,当refresh_token失效之后,需要用户重新授权。
注意:此接口频率限制为 5 万/分钟
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=APPID&grant_type=GRANT_TYPE&refresh_token=REFRESH_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
appid | string | 是 | - | 公众号的唯一标识 |
grant_type | string | 是 | refresh_token | 填写为refresh_token |
refresh_token | string | 是 | - | 填写通过access_token获取到的refresh_token参数 |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
access_token | string | 网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同 |
expires_in | number | access_token接口调用凭证超时时间,单位(秒) |
refresh_token | string | 用户刷新access_token |
openid | string | 用户唯一标识 |
scope | string | 用户授权的作用域,使用逗号(,)分隔 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=APPID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN
返回示例
{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40029 | code 无效 | js_code无效 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
服务号 | 移动应用 | 网站应用 |
---|---|---|
仅认证 | ✔ | ✔ |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;