Third-party platforms may use the API Pull Basic Information Of All Current Authorized Accounts.
For management convenience, and for helping Official Account and Mini Program operators speedily understand and authorize their own APIs and feature permissions, API permissions of Official Accounts and Mini Programs are organized as follows:
Official Account permission set:
Message management permissions
Weixin multi-customer service permissions
Broadcast and notification permissions
Media Asset Management permissions
Weixin Shake Nearby permissions
Public services API permissions
Weixin Open Platform account management permissions
Mini Program permission set
Account management permissions
Development management and data analysis permissions
Customer service message management permissions
Weixin Open Platform account management permissions
Mini Program plug-in management permission set
Mini Program nearby locations permission set
Notes:
When you modify permissions for third-party platforms that have been published to the entire network and the status of the current network-wide release has not been overwritten, the permissions on the authorization page will remain the permissions option for the network when testing the Official Account.
For information on various types of Official Accounts and whether or not they have been verified, and which API permissions they possess (the type of every authorized Official Account can be retrieved through the API listed in the following document), refer to https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Explanation_of_interface_privileges.html.
For details of the Mini Program API, refer to https://mp.weixin.qq.com/debug/wxadoc/dev/api/
- Official Accounts may grant Weixin voucher permissions to third-party platforms even if they do not have the API permissions (e.g. Weixin voucher API permissions). After the Official Account acquires the API, the third-party platforms may immediately replace the Official Account in calling the API.
If a third-party platform needs to add new features that require new permissions, attention must be paid to the following:
1. As long as it is the first network-wide release (including subsequent modifications after the network-wide release), current users will never be affected and can use the API normally.
2. Third-party platforms may add new permissions if required to meet new business needs. Third-party platforms can modify platform permissions on the Weixin Open Platform. After the modifications are approved and released to the entire network, new permissions requests will be added during the authorization process for new Official Accounts, and existing users and previous permissions are unaffected (in other words, their operations will not be affected). However, the new authorization set requires authorization upgrades before it can be granted (this is because it is necessary to respect the user's choice. For example, when Weixin adds a new feature such as Weixin Cards and Offers, it cannot assume that users are willing to grant the permissions for this new service to the original third-party).
3. In third-party platform design, e.g. in material management, it is recommended that developers design as follows: after adding the Media Asset Management function, new users are still requested to grant permissions normally (at this point, users will grant all stated permissions to the third party). Existing users who access the Media Asset Management function will be prompted to upgrade permissions to use the new function. The developer only has to guide the user to the authorization page to perform the upgrade.
The permissions are described in detail below (all the following permissions can be granted to multiple third-party platforms at the same time):
Official Account permissions are as follows:
# Message management permissions
(Permission set ID: 1)
This means that after being granted these permissions by Official Accounts, third-party platforms acquire message management and reply permissions for these accounts. Details include:
1) Receive messages sent by users (and thus the ability to automatically respond to keywords). Note that various user-triggered business events are placed within their respective business permissions and pushed to relevant third parties granted those permissions.
2) Send messages to users via the customer service API
3) Acquire and configure voice recognition switch status
4) Acquire and configure location reporting switch status
5) Upload/Download multimedia files
6) Push following/unfollowing events (including followering events brought by QR codes with parameters), and automatically reply to followers after being followed
Note that third-party platforms only require authorization for a single business module (they do not have to acquire customer service and menu permissions). After receiving the business module event push notification, if the event allows for passive replies to the follower within 5 seconds, the third-party may deliver a passive reply (consult the specific business module to find out which event push notifications of the module allow passive replies to users, and which do not). Click to view the "Passive Reply" API documentation.
In addition, note that if third-party platforms desire to obtain real-time updates of new Official Account followers, they need only reply with "success" when they receive notifications of new followers. No separate reply is needed. This is to avoid the Official Account receiving automatic replies from multiple third-party platforms regarding new followers.
# Custom menu permissions
(Permission set ID: 15)
This means that after being granted these permissions by Official Accounts, third-party platforms acquire permissions to set up and respond to custom menus for these accounts. Details include:
1) Create/query and delete custom menus, including personalized menus
2) Receive custom menu click events and deliver passive responses within 5 seconds based on the event
# User management permissions
(Permission set ID: 2)
This means that after being granted these permissions by Official Accounts, third-party platforms acquire user management permissions of these accounts. Details include:
1) Acquire user basic information API
2) Acquire user list API
3) User group management API
4) User alias configuration API
5) Configure user location switch and reporting method
6) Get event push notifications based on user location reports
7) Event push notifications for following/unfollowing of Official Accounts
# Account service permissions
(Permission set ID: 3)
This permission set is mainly for account management of Official Accounts, including acquiring and configuring Official Account messages. As it can be acquired and configured by multiple parties, the authorization is not mutually exclusive. Details include:
1) Generate QR codes with parameters
2) An event is received when a QR code with parameters is scanned (not after the account is followed). Note that when a QR code with parameters is scanned and the user follows the account, the event notification is pushed to third parties with message and menu management permissions.
3) Get Official Account basic information (such as the profile photo, alias, and account type). This API is exclusive to service providers.
4) Upload/Download multimedia files
# Web page service permissions
(Permission set ID: 4)
This permission set indicates that third-party platforms can initiate Weixin web page authorization on behalf of Official Accounts, and legally acquire related authorization information after authorization, including using JS SDK on behalf of Official Accounts. Details include:
1) Initiate web page authorization within Weixin
2) Get basic information of users who have granted permissions (permissions differ depending on the app's permissions application scope: when the scope acts as the snsapi_base, the authorization page does not pop up but third-party platforms can only get the user's openid); when the scope acts as the snsapi_userinfo, the authorization page pops up but third-party platforms can acquire the user's alias, gender, and location via openid)
3) Use JS SDK on behalf of Official Accounts
# Weixin Store permissions
(Permission set ID: 5)
This permission set refers to the ability to manage stores on Weixin Official Accounts Platform. Details include:
1) All Weixin Store API permissions
2) All Weixin Store events (pushed to the Official Account messages and event reception URL that was filled in when the service was created)
# Weixin multi-customer service permissions
(Permission set ID: 6)
This permission set refers to the ability to configure and acquire the status of the Official Account's multi-customer service feature switch. Once the switch is enabled, customer service messages will not be pushed to the third-party platform, but will be pushed to the Weixin multi-customer service backend. Then, the operator of the Official Account needs to download the multi-ustomer service PC client from the multiple customer service module on mp.weixin.qq.com to undergo CRM communication and interaction with followers who send customer service messages. Details include:
1) All Weixin multi-customer service API permissions
# Broadcast and notification permissions
(Permission set ID: 7)
This permission set refers to Official Accounts' ability to notify users via APIs. As multiple third-party developers are allowed to notify users of their respective services, these permissions can be granted to multiple third-party platforms, which means authorization is not mutually exclusive. Details include:
1) Message template API
2) Advanced broadcast API
# Weixin voucher permissions
(Permission set ID: 8)
These include all API permissions and events related to Weixin vouchers, including:
1) Permissions of all Weixin voucher APIs
2) All Weixin voucher events (pushed to the Official Account messages and event reception URL that was filled in when the service was created)
3) Upload/Download multimedia files
# Weixin Scan permissions
(Permission set ID: 9)
These include all API permissions and events related to Weixin Scan, including:
1)All Weixin Scan API permissions and events
# Wi-Fi via Weixin permissions
(Permission set ID: 10)
These include all API permissions and events related to Wi-Fi via Weixin, including:
1)All Wi-Fi via Weixin API permissions
# Media Asset Management permissions
(Permission set ID: 11)
These permissions refer to the third-party developers' ability to manage media such as articles, images, voice messages, videos, and thumbnails on behalf of Official Accounts, including:
1) Add and get temporary media (original API for uploading and downloading multimedia files)
2) Add, get, and delete permanent media
3) Modify permanent article media
4) Get the list of all various media and their total number
# Weixin Shake Nearby permissions
(Permission set ID: 12)
These include all API permissions and events related to Weixin Shake Nearby, including:
1) All Weixin Shake Nearby API permissions
# Weixin Shop permissions
(Permission set ID: 13)
These include all API permissions and events related to Weixin Shop, including:
1) All offline shop API permissions
# Public services API permissions
(Permission set ID: 22)
These permissions refer to the abilities to send messages to users from public services, store service records, and push event notifications. Details include:
1) All public services API permissions
# Weixin e-invoice permissions
(Permission set ID: 26)
These permissions refer to Official Accounts' ability to use Weixin e-invoices. Details include:
1) Open the "Add Weixin E-invoices" authorization page
2) Add e-invoices into Weixin Cards & Offers
2) Reimburse Weixin e-invoices
# Weixin Open Platform account linking permissions
(Permission set ID: 24)
After being granted the permissions, third-party platforms may create open platform accounts or perform linking/unlinking operations on behalf of Official Accounts on Weixin Open Platform. Official Accounts and Mini Programs under the same user share the same unionid if they are linked to the same account. This permission set can only be granted to one third-party platform, and this authorization is mutually exclusive. The APIs within the permission set are as follows:
1) Create a Weixin Open Platform account and Link with Official Account
2) Link the Official Account to an existing Weixin Open Platform account
3) Unlink the Official Account from the Weixin Open Platform account
4) Get the Weixin Open Platform account linked with the Official Account
For more information on the APIs, visit open.weixin.qq.com and go to Resource Center >Third-Party Platforms > Implementing Businesses on Behalf of Official Accounts > Weixin Open Platform Account Management.
Mini Program permissions are as follows:
# Account management permissions
(Permission set ID: 17)
This permission set is mainly for account management of Mini Programs, including acquiring and configuring Mini Program account messages. As it can be acquired by multiple parties, the authorization is not mutually exclusive. Details include:
1) Generate QR codes with parameters
2) Change and query user access status
3) Get Official Account basic information (such as the profile photo, alias, and account type). This API is exclusive to service providers.
# Development management and data analysis permissions
(Permission set ID: 18)
This permission set mainly develops and manages Mini Program code, links testers, creates message templates, configures server information, gets Mini Program data, etc. To prevent the code from being overwritten, this permission set can only be granted to one third-party platform. Details include:
1) Push code review related events
2) Submit the application for code test
3) Get test QR code
4) Link tester
5) Submit code review
6) Query code review status
7) Publish code
8) Set server address
9) Template message
10) Weixin login
11) Data analysis
# Customer service message management permissions
(Permission set ID: 19)
This permission set is mainly for Mini Program customer service message management and development, and can be granted to multiple third-party platforms. Details include:
1) Send customer service messages
2) Upload media
# Weixin Open Platform account linking permissions
After being granted the permissions, third-party platforms may create open platform accounts or perform linking/unlinking operations on behalf of Mini Programs on Weixin Open Platform. Official Accounts and Mini Programs under the same user share the same unionid if they are linked to the same account. This permission set can only be granted to one third-party platform, and this authorization is mutually exclusive. The APIs within the permission set are as follows:
1) Create an Weixin Open Platform account and Link with Mini Program
2) Link the Mini Program to an existing Weixin Open Platform account
3) Unlink the Mini Program from the Weixin Open Platform account
4) Get the Weixin Open Platform account linked with the Mini Program
For more information on the APIs, visit open.weixin.qq.com and go to Resource Center >Third-Party Platforms > Implementing Businesses on Behalf of Mini Programs > Weixin Open Platform Account Management.
# Mini Programs plug-in management permission set
(Permission set ID: 40)
After being granted the permissions, third-party platforms may manage plug-ins on behalf of Mini Programs. This permission set can be granted to multiple third-party platforms. The APIs within the permission set are as follows:
1) Apply for adding plug-ins
2) Query added plug-ins
3) Delete added plug-ins
# Mini Program nearby locations permission set
(Permission set ID: 37)
After being granted the permissions, third-party platforms can help Mini Programs create and manage nearby locations, and can configure the Mini Program to be displayed in Mini Programs Nearby.
The specific APIs within the permission set are as follows:
# Mini Program basic information setup permissions
(Permission set ID: 30)
After being granted the permissions, third-party platforms can help Mini Programs created through the API to set up basic information such as name, profile photo, profile, category, etc.
The specific APIs within the permission set are as follows:
Mini Program Basic Information API