# Test personalized menu matching results

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface English name: tryMatchMenu

Test the menu configuration that the user sees

# 1. How to call

# HTTPS calls

POST https://api.weixin.qq.com/cgi-bin/menu/trymatch?access_token=ACCESS_TOKEN

# Cloud Calls

  • Call method: officialAccount.menu.tryMatch

  • The input and exit parameters are the same as the HTTPS call, which can be called in the cloud call documentation

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • The permission set id to which the interface belongs is: 15

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductions
user_idstringyesweixinUser OpenID or WeChat

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
buttonobjarray-

# Res.button(Array)Object Payload

Parameter NametypeExampleIntroductionsto enumerate
namestringSongs of the dayMenu title, no more than 16 bytes, submenu no more than 60 bytes-
typestringclickResponse action type of menu (exclusive of sub_button)click view scancode_push scancode_waitmsg pic_sysphoto pic_photo_or_album pic_weixin location_select media_id article_id article_view_limited
sub_buttonobjarray-Array of secondary menu structures-
keystring-The menu KEY value, used for message interface push, does not exceed 128 bytes. Click, etc. Click types must be.-
urlstring-Web links, which users can open by clicking on a menu, are no more than 1024 bytes.When type is miniprogram, older versions of the Portals that do not support Weixin Mini Program will open this url.View, miniprogram types are required.-
media_idstring-The valid media_id returned by calling the new permanent material interface. The media_id type and the view_limited type must-
appidstring-Weixin Mini Program of AppID (only Official Account can be configured), the miniprogram type must-
pagepathstring-The page path of Weixin Mini Program, the miniprogram type must-
article_idstring-The legal article_id, article_id type, and article_view_limited type obtained after publication must be-

# Res.button(Array).sub_buttonObject Payload

Array of secondary menu structures

Parameter NametypeExampleIntroductions
typestringclickThe response action type of the menu (type of the same level menu)
namestringSongs of the dayMenu title, no more than 16 bytes, submenu no more than 60 bytes
keystring-The menu KEY value, used for message interface push, does not exceed 128 bytes. Click, etc. Click types must be.
urlstring-Web links, which users can open by clicking on a menu, are no more than 1024 bytes.When type is miniprogram, older versions of the Portals that do not support Weixin Mini Program will open this url.View, miniprogram types are required.
media_idstring-The valid media_id returned by calling the new permanent material interface. The media_id type and the view_limited type must
appidstring-Weixin Mini Program of AppID (only Official Account can be configured), the miniprogram type must
pagepathstring-The page path of Weixin Mini Program, the miniprogram type must
article_idstring-The legal article_id, article_id type, and article_view_limited type obtained after publication must be

# 4. Note

  1. Limit to 20,000 tests per day
  2. Menus that contain repealed fields will also automatically fail and are no longer matched. This will also be reflected in this test interface.

# 5. Code examples

Example Requests

{
  "user_id":"weixin"
}

Return an example

{
    "button": [
        {
            "type": "view", 
            "name": "tx", 
            "url": "http://www.qq.com/", 
            "sub_button": [ ]
        }, 
        {
            "type": "view", 
            "name": "tx", 
            "url": "http://www.qq.com/", 
            "sub_button": [ ]
        }, 
        {
            "type": "view", 
            "name": "tx", 
            "url": "http://www.qq.com/", 
            "sub_button": [ ]
        }
    ]
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
0okok

# 7. Scope of application

How this interface can be invoked under different account types:
Official Account Service Account
Certification only Certification only
  • Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
  • Other account types that are not expressly stated may not be called on this interface without special instructions;