Obtain access_token using code

API Description

This API is used to get access_token using code.

Request Description

HTTP request method: GET
https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code

Parameters

Response Description

Response for a successful request:

{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
}

Example of response for a failed request:

{
"errcode":40029,"errmsg":"invalid code"
}

Refreshing/Renewing access_token

API Description

access_token is the credential used to call the authorized API. The validity period of access_token is short (2 hours). When it expires, you can use refresh_token to refresh it. There are two refresh results:

1. If access_token has expired, a new access_token and a new validity period will be obtained by calling refresh_token.

2. If access_token remains valid, using refresh_token will not change access_token, but the validity period will be refreshed, which is equivalent to the renewal of access_token.

The refresh_token has a long validity period (30 days) and cannot be renewed. If refresh_token expired, a user's re-authorization is required before the user's profile photo and alias can be obtained.

Request method

refresh_token obtained through the /sns/oauth2/access_token API can be used to call the following APIs:

HTTP request method: GET
https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=APPID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Parameters

Response Description

Response for a successful request:

{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
}

Example of response for a failed request:

{
"errcode":40030,"errmsg":"invalid refresh_token"
}

API Description

Check the validity of the authorization credential (access_token)

Request Description

HTTP request method: GET
https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID

Parameters

Response Description

The returned JSON packet for a successful request:

{
"errcode":0,"errmsg":"ok"
}

Example of returned JSON packet for a failed request:

{
"errcode":40003,"errmsg":"invalid openid"
}

Get the user's personal information (UnionID mechanism)

API Description

This API is used to get users' personal information. Developers are able to access user profiles via OpenIDs. Note: If a developer has more than one apps, website applications, and official accounts, the uniqueness of users can be identified by the UnionID contained in basic user information. For the mobile apps, website applications, and official accounts under the same Weixin Open Platform account, the UnionID of a user is unique. In other words, a user has one UnionID in different apps under the same account of the Weixin Open Platform. When a user changes the Weixin profile photo, the URL of the old profile photo becomes invalid. Therefore, after they get user information, developers should save the profile photo to avoid the profile photo URL from being invalid.

Request Description

HTTP request method: GET
https://api.weixin.qq.com/sns/userinfo?access_token=ACCESS_TOKEN&openid=OPENID

Parameters

Response Description

The returned JSON packet for a successful request:

{
"openid":"OPENID",
"nickname":"NICKNAME",
"sex":1,
"province":"PROVINCE",
"city":"CITY",
"country":"COUNTRY",
"headimgurl": "http://wx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/0",
"privilege":[
"PRIVILEGE1",
"PRIVILEGE2"
],
"unionid": " o6_bmasdasdsad6_2sgVt7hMZOPfL"
}

Note:

It is recommended that developers save unionID information to facilitate user information interoperability between different apps.

Example of returned JSON packet for a failed request

{
"errcode":40003,"errmsg":"invalid openid"
}

Call frequency limits