微信公众平台开发模式自定义菜单接口API文档

移动开发
微信自定义菜单是仍在内测中的功能,预计在微信5.0时正式发布,目前已停止内测资格申请。不过先学习一下可以在开放后第一时间用上。本文档为微信官方文档,包含自定义菜单接口API的完整说明。

简介

开发者获取使用凭证后,可以使用该凭证对公众账号的自定义菜单进行创建、查询和删除等操作。 自定义菜单接口可实现以下类型按钮:

click(点击事件):

用户点击click类型按钮后,微信服务器会通过消息接口(event类型)推送点击事件给开发者,并且带上按钮中开发者填写的key值,开发者可以通过自定义的key值进行消息回复。

创建自定义菜单后,由于微信客户端缓存,需要24小时微信客户端才会展现出来。建议测试时可以尝试取消关注公众账号后,再次关注,则可以看到创建后的效果。

菜单创建

接口说明

通过POST一个特定结构体,实现在微信客户端创建自定义菜单。

请求说明

http请求方式:POST
https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN

请求示例

 {
     "button":[
     {	
          "type":"click",
          "name":"今日歌曲",
          "key":"V1001_TODAY_MUSIC"
      },
      {
           "type":"click",
           "name":"歌手简介",
           "key":"V1001_TODAY_SINGER"
      },
      {
           "name":"菜单",
           "sub_button":[
            {
               "type":"click",
               "name":"hello word",
               "key":"V1001_HELLO_WORLD"
            },
            {
               "type":"click",
               "name":"赞一下我们",
               "key":"V1001_GOOD"
            }]
       }]
 }

创建后效果:

参数说明

参数 是否必须 说明
button 按钮数组,按钮个数应为2~3个
sub_button 子按钮数组,按钮个数应为2~5个
type 按钮类型,目前有click类型
name 按钮描述,既按钮名字,不超过16个字节,子菜单不超过40个字节
key 类型为click必须 按钮KEY值,用于消息接口(event类型)推送,不超过128字节

返回说明

正确的Json返回结果:

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

错误的Json返回结果

{"errcode":40018,"errmsg":"invalid button name size"}
 

菜单查询

接口说明

查询当前使用的自定义菜单结构。

请求说明

http请求方式:GET
https://api.weixin.qq.com/cgi-bin/menu/get?access_token=ACCESS_TOKEN

返回说明

对应创建接口,正确的Json返回结果:
{"menu":{"button":[{"type":"click","name":"今日歌曲","key":"V1001_TODAY_MUSIC","sub_button":[]},{"type":"click","name":"歌手简介","key":"V1001_TODAY_SINGER","sub_button":[]},{"name":"菜单","sub_button":[{"type":"click","name":"hello word","key":"V1001_HELLO_WORLD","sub_button":[]},{"type":"click","name":"赞一下我们","key":"V1001_GOOD","sub_button":[]}]}]}}

菜单删除

接口说明

取消当前使用的自定义菜单。

请求说明

http请求方式:GET
https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=ACCESS_TOKEN

返回说明

对应创建接口,正确的Json返回结果:
{"errcode":0,"errmsg":"ok"}
 
责任编辑:徐川 来源: 微信
相关推荐

2013-04-10 18:29:09

微信公众平台接口开发

2013-04-10 18:24:48

微信公众平台接口开发

2013-03-28 11:32:07

微信菜单轻App

2013-03-25 17:26:09

2013-04-10 18:45:52

微信公众平台接口开发

2015-02-12 15:33:43

微信SDK

2013-11-13 00:51:22

微信微信公号微信公众账号

2013-04-10 16:15:40

微信公众平台接口开发

2015-02-12 15:38:26

微信SDK

2014-09-24 11:45:15

微信企业号开发

2013-04-10 18:07:08

微信公众平台接口开发

2013-04-10 18:19:40

微信公众平台接口开发

2021-03-04 00:06:16

微信开发自定义

2013-04-10 17:59:50

微信公众平台接口开发

2014-11-20 09:38:40

C#

2013-04-15 16:56:48

微信公众平台Android开发

2013-04-10 16:51:56

微信公众平台接口开发

2013-11-13 07:19:19

2013-04-08 16:14:10

微信微信公众平台

2013-03-29 11:08:06

微信轻App应用商店
点赞
收藏

51CTO技术栈公众号