微信服务号一旦绑定后台服务器后就不能通过微信公众平台来创建修改微信服务号的菜单了。即需要自己后台调用微信平台接口实现创建自定义的菜单。
请注意:
- 自定义菜单最多包括3个一级菜单,每个一级菜单最多包含5个二级菜单。
- 一级菜单最多4个汉字,二级菜单最多7个汉字,多出来的部分将会以“...”代替。
- 创建自定义菜单后,菜单的刷新策略是,在用户进入公众号会话页或公众号profile页时,如果发现上一次拉取菜单的请求在5分钟以前,就会拉取一下菜单,如果菜单有更新,就会刷新客户端的菜单。测试时可以尝试取消关注公众账号后再次关注,则可以看到创建后的效果。
自定义菜单接口可实现多种类型按钮,如下:
- click:点击推事件用户点击click类型按钮后,微信服务器会通过消息接口推送消息类型为event的结构给开发者(参考消息接口指南),并且带上按钮中开发者填写的key值,开发者可以通过自定义的key值与用户进行交互;
- view:跳转URL用户点击view类型按钮后,微信客户端将会打开开发者在按钮中填写的网页URL,可与网页授权获取用户基本信息接口结合,获得用户基本信息。
- scancode_push:扫码推事件用户点击按钮后,微信客户端将调起扫一扫工具,完成扫码操作后显示扫描结果(如果是URL,将进入URL),且会将扫码的结果传给开发者,开发者可以下发消息。
- scancode_waitmsg:扫码推事件且弹出“消息接收中”提示框用户点击按钮后,微信客户端将调起扫一扫工具,完成扫码操作后,将扫码的结果传给开发者,同时收起扫一扫工具,然后弹出“消息接收中”提示框,随后可能会收到开发者下发的消息。
- pic_sysphoto:弹出系统拍照发图用户点击按钮后,微信客户端将调起系统相机,完成拍照操作后,会将拍摄的相片发送给开发者,并推送事件给开发者,同时收起系统相机,随后可能会收到开发者下发的消息。
- pic_photo_or_album:弹出拍照或者相册发图用户点击按钮后,微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。用户选择后即走其他两种流程。
- pic_weixin:弹出微信相册发图器用户点击按钮后,微信客户端将调起微信相册,完成选择操作后,将选择的相片发送给开发者的服务器,并推送事件给开发者,同时收起相册,随后可能会收到开发者下发的消息。
- location_select:弹出地理位置选择器用户点击按钮后,微信客户端将调起地理位置选择工具,完成选择操作后,将选择的地理位置发送给开发者的服务器,同时收起位置选择工具,随后可能会收到开发者下发的消息。
- media_id:下发消息(除文本消息)用户点击media_id类型按钮后,微信服务器会将开发者填写的永久素材id对应的素材下发给用户,永久素材类型可以是图片、音频、视频、图文消息。请注意:永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。
- view_limited:跳转图文消息URL用户点击view_limited类型按钮后,微信客户端将打开开发者在按钮中填写的永久素材id对应的图文消息URL,永久素材类型只支持图文消息。请注意:永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。
请注意,3到8的所有事件,仅支持微信iPhone5.4.1以上版本,和Android5.4以上版本的微信用户,旧版本微信用户点击后将没有回应,开发者也不能正常接收到事件推送。9和10,是专门给第三方平台旗下未微信认证(具体而言,是资质认证未通过)的订阅号准备的事件类型,它们是没有事件推送的,能力相对受限,其他类型的公众号不必使用。
接口调用请求说明
http请求方式:POST(请使用https协议) https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN
click和view的请求示例
{
"button":[
{
"type":"click",
"name":"今日歌曲",
"key":"V1001_TODAY_MUSIC"
},
{
"name":"菜单",
"sub_button":[
{
"type":"view",
"name":"搜索",
"url":"http://www.soso.com/"
},
{
"type":"miniprogram",
"name":"wxa",
"url":"http://mp.weixin.qq.com",
"appid":"wx286b93c14bbf93aa",
"pagepath":"pages/lunar/index"
},
{
"type":"click",
"name":"赞一下我们",
"key":"V1001_GOOD"
}]
}]
}
其他新增按钮类型的请求示例
{
"button": [
{
"name": "扫码",
"sub_button": [
{
"type": "scancode_waitmsg",
"name": "扫码带提示",
"key": "rselfmenu_0_0",
"sub_button": [ ]
},
{
"type": "scancode_push",
"name": "扫码推事件",
"key": "rselfmenu_0_1",
"sub_button": [ ]
}
]
},
{
"name": "发图",
"sub_button": [
{
"type": "pic_sysphoto",
"name": "系统拍照发图",
"key": "rselfmenu_1_0",
"sub_button": [ ]
},
{
"type": "pic_photo_or_album",
"name": "拍照或者相册发图",
"key": "rselfmenu_1_1",
"sub_button": [ ]
},
{
"type": "pic_weixin",
"name": "微信相册发图",
"key": "rselfmenu_1_2",
"sub_button": [ ]
}
]
},
{
"name": "发送位置",
"type": "location_select",
"key": "rselfmenu_2_0"
},
{
"type": "media_id",
"name": "图片",
"media_id": "MEDIA_ID1"
},
{
"type": "view_limited",
"name": "图文消息",
"media_id": "MEDIA_ID2"
}
]
}
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
button | 是 | 一级菜单数组,个数应为1~3个 |
sub_button | 否 | 二级菜单数组,个数应为1~5个 |
type | 是 | 菜单的响应动作类型,view表示网页类型,click表示点击类型,miniprogram表示小程序类型 |
name | 是 | 菜单标题,不超过16个字节,子菜单不超过60个字节 |
key | click等点击类型必须 | 菜单KEY值,用于消息接口推送,不超过128字节 |
url | view、miniprogram类型必须 | 网页 链接,用户点击菜单可打开链接,不超过1024字节。 type为miniprogram时,不支持小程序的老版本客户端将打开本url。 |
media_id | media_id类型和view_limited类型必须 | 调用新增永久素材接口返回的合法media_id |
appid | miniprogram类型必须 | 小程序的appid(仅认证公众号可配置) |
pagepath | miniprogram类型必须 | 小程序的页面路径 |
参考文档:微信官方文档
直接上代码
package com.xianquan.wx.aixuexiao.util; import com.alibaba.fastjson.JSONObject; import com.xianquan.wx.aixuexiao.model.BasicButton; import com.xianquan.wx.aixuexiao.model.CommonButton; import com.xianquan.wx.aixuexiao.model.ComplexButton; import com.xianquan.wx.aixuexiao.model.Menu; import com.xianquan.wx.weixin.sdk.propertie.WeixinGlobal; import com.xianquan.wx.weixin.sdk.util.AccessTokenUtil; import org.apache.log4j.Logger; import static com.xianquan.wx.aixuexiao.util.HttpRequest.httpRequest; /** * @ClassName: MenuManager * @Description: 菜单管理器类 * @Author: lcoil * @Date: 2019/8/23 */ public class MenuManager { private static Logger logger = Logger.getLogger(MenuManager.class); public static void main(String[] args) { // 第三方用户唯一凭证 String appId = WeixinGlobal.APPID; // 第三方用户唯一凭证密钥 String appSecret = WeixinGlobal.APPSECRET; // 调用接口获取access_token String accessToken = AccessTokenUtil.queryAccessToken(); if (null != accessToken) { // 调用接口创建菜单 int result = createMenu(putMenu(), accessToken); if (0 == result) logger.info("菜单创建成功!"); else logger.info("菜单创建失败,错误码:" + result); getMenu(accessToken); } } /** * 组装菜单数据 * * @return */ private static Menu putMenu() { CommonButton btn11 = new CommonButton(); btn11.setName("按钮11"); btn11.setType("click"); btn11.setKey("11"); CommonButton btn12 = new CommonButton(); btn12.setName("按钮12"); btn12.setType("click"); btn12.setKey("12"); CommonButton btn13 = new CommonButton(); btn13.setName("按钮13"); btn13.setType("click"); btn13.setKey("13"); CommonButton btn21 = new CommonButton(); btn21.setName("百度链接"); btn21.setType("view"); btn21.setUrl("http://www.baidu.com"); CommonButton btn22 = new CommonButton(); btn22.setName("我的博客地址"); btn22.setType("view"); btn22.setUrl("https://www.cnblogs.com/xianquan/"); CommonButton btn31 = new CommonButton(); btn31.setName("使用费缴纳"); btn31.setType("view"); btn31.setUrl("http://xqpay.natapp1.cc/wechat/"); /*btn31.setType("click"); btn31.setKey("31");*/ CommonButton btn32 = new CommonButton(); btn32.setName("使用费缴纳"); btn32.setType("click"); btn32.setKey("32"); CommonButton btn33 = new CommonButton(); btn33.setName("打赏"); btn33.setType("click"); btn33.setKey("33"); ComplexButton mainBtn1 = new ComplexButton(); mainBtn1.setName("按钮"); mainBtn1.setSub_button(new CommonButton[] { btn11,btn12, btn13,}); ComplexButton mainBtn2 = new ComplexButton(); mainBtn2.setName("链接"); mainBtn2.setSub_button(new CommonButton[] { btn21, btn22}); ComplexButton mainBtn3 = new ComplexButton(); mainBtn3.setName("费用支付"); mainBtn3.setSub_button(new CommonButton[] { btn31, btn32, btn33 }); Menu menu = new Menu(); menu.setButton(new BasicButton[] { mainBtn1, mainBtn2, mainBtn3 }); return menu; } /** * 创建菜单 * * @param menu 菜单实例 * @param accessToken 有效的access_token * @return 0表示成功,其他值表示失败 */ public static int createMenu(Menu menu, String accessToken) { int result = 0; // 拼装创建菜单的url String url =WeixinGlobal.MENU_CREATE_URL.replace("ACCESS_TOKEN", accessToken); // 将菜单对象转换成json字符串 String jsonMenu = JSONObject.toJSONString(menu); // 调用接口创建菜单 JSONObject jsonObject = httpRequest(url, "POST", jsonMenu); if (null != jsonObject) { if (0 != jsonObject.getInteger("errcode")) { result = jsonObject.getInteger("errcode"); logger.error("创建菜单失败 errcode:"+ jsonObject.getInteger("errcode")+",errmsg:"+ jsonObject.getString("errmsg")); } } else {} return result; } /** * 删除菜单 * @param accessToken * @return */ public static int delMenu(String accessToken){ int result = 0; String url = WeixinGlobal.MENU_DELTE_URL.replace("ACCESS_TOKEN", accessToken); JSONObject jsonObject = httpRequest(url,"GET",""); if(null != jsonObject){ if (0 != jsonObject.getInteger("errcode")) { result = jsonObject.getInteger("errcode"); logger.error("删除菜单失败 errcode:"+ jsonObject.getInteger("errcode")+",errmsg:"+ jsonObject.getString("errmsg")); } } return result; } /** * 获取菜单 * @param accessToken * @return */ public static String getMenu(String accessToken){ String result = ""; String url = WeixinGlobal.MENU_GET_URL.replace("ACCESS_TOKEN",accessToken); JSONObject jsonObject = httpRequest(url,"GET",""); if(jsonObject != null){ result = jsonObject.toJSONString(); logger.debug("获取菜单成功"+result); } return result; } }