# 测试个性化菜单匹配结果

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:tryMatchMenu

测试用户看到的菜单配置

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 调用方法:officialAccount.menu.tryMatch

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:15

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
user_idstringweixin用户OpenID或微信号

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
buttonobjarray-

# Res.button(Array) Object Payload

参数名类型示例说明
namestring今日歌曲菜单标题,不超过16个字节,子菜单不超过60个字节
typestringclick菜单的响应动作类型(与 sub_button 互斥)
sub_buttonobjarray-二级菜单结构体数组
keystring-菜单KEY值,用于消息接口推送,不超过128字节。click等点击类型必须。
urlstring-网页链接,用户点击菜单可打开链接,不超过1024字节。 type为miniprogram时,不支持小程序的老版本客户端将打开本url。view、miniprogram类型必填。
media_idstring-调用新增永久素材接口返回的合法media_id。media_id类型和view_limited类型必须
appidstring-小程序的appid(仅认证公众号可配置),miniprogram类型必须
pagepathstring-小程序的页面路径,miniprogram类型必须
article_idstring-发布后获得的合法 article_id,article_id类型和article_view_limited类型必须

# Res.button(Array).sub_buttonObject Payload

二级菜单结构体数组

参数名类型示例说明
typestringclick菜单的响应动作类型(同一级菜单的 type)
namestring今日歌曲菜单标题,不超过16个字节,子菜单不超过60个字节
keystring-菜单KEY值,用于消息接口推送,不超过128字节。click等点击类型必须。
urlstring-网页链接,用户点击菜单可打开链接,不超过1024字节。 type为miniprogram时,不支持小程序的老版本客户端将打开本url。view、miniprogram类型必填。
media_idstring-调用新增永久素材接口返回的合法media_id。media_id类型和view_limited类型必须
appidstring-小程序的appid(仅认证公众号可配置),miniprogram类型必须
pagepathstring-小程序的页面路径,miniprogram类型必须
article_idstring-发布后获得的合法 article_id,article_id类型和article_view_limited类型必须

# 4. 注意事项

  1. 每日测试限制20000次
  2. 包含已废除字段的菜单也将自动失效,不再被匹配。这一点也将体现在本测试接口中。

# 5. 代码示例

请求示例

{
  "user_id":"weixin"
}

返回示例

{
    "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. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
0okok

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;