# 获取自定义菜单配置

调试工具

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

接口英文名：getMenu

使用接口创建自定义菜单后，开发者还可使用接口查询自定义菜单的结构。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

• 调用方法：officialAccount.menu.get

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

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

无

# 3. 返回参数

# 返回体 Response Payload

# Res.menu Object Payload

默认菜单信息

# Res.conditionalmenu(Array) Object Payload

个性化菜单列表

# Res.menu.button(Array) Object Payload

一级菜单数组(1-3个)

# Res.menu.button(Array).sub_buttonObject Payload

二级菜单结构体数组

# Res.conditionalmenu(Array).buttonObject Payload

一级菜单数组(1-3个)

# Res.conditionalmenu(Array).button.sub_buttonObject Payload

二级菜单结构体数组

# Res.conditionalmenu(Array).matchrule Object Payload

菜单匹配规则(至少一个非空字段)

# 4. 注意事项

在设置了个性化菜单后，使用本自定义菜单查询接口可以获取默认菜单和全部个性化菜单信息。

# 5. 代码示例

# 5.1 查询默认菜单

请求示例

无

返回示例

{
  "menu": {
    "button": [
      {
        "type": "click",
        "name": "今日歌曲",
        "key": "V1001_TODAY_MUSIC",
        "sub_button": []
      }
    ]
  }
}

# 5.2 查询个性化菜单

请求示例

无

返回示例

{
  "menu": {
    "button": [
      {
        "type": "click",
        "name": "今日歌曲",
        "key": "V1001_TODAY_MUSIC",
        "sub_button": []
      }
    ],
    "menuid": 208396938
  },
  "conditionalmenu": [
    {
      "button": [
        {
          "type": "click",
          "name": "今日歌曲",
          "key": "V1001_TODAY_MUSIC",
          "sub_button": []
        }
      ],
      "matchrule": {
        "group_id": 2,
        "sex": 1
      },
      "menuid": 208396993
    }
  ]
}

# 6. 错误码

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

# 7. 适用范围