微信公众号-自定义菜单的创建

末蓝、 2022-12-22 04:36 160阅读 0赞

**获取access\_token**  
access\_token是公众号的全局唯一接口调用凭据，公众号调用各接口时都需使用access\_token。开发者需要进行妥善保存。access\_token的存储至少要保留512个字符空间。access\_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的access\_token失效。

公众平台的API调用所需的access\_token的使用及生成方式说明：

1、建议公众号开发者使用中控服务器统一获取和刷新access\_token，其他业务逻辑服务器所使用的access\_token均来自于该中控服务器，不应该各自去刷新，否则容易造成冲突，导致access\_token覆盖而影响业务；

2、目前access\_token的有效期通过返回的expire\_in来传达，目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新access\_token。在刷新过程中，中控服务器可对外继续输出的老access\_token，此时公众平台后台会保证在5分钟内，新老access\_token都可用，这保证了第三方业务的平滑过渡；

3、access\_token的有效时间可能会在未来有调整，所以中控服务器不仅需要内部定时主动刷新，还需要提供被动刷新access\_token的接口，这样便于业务服务器在API调用获知access\_token已超时的情况下，可以触发access\_token的刷新流程。

4、对于可能存在风险的调用，在开发者进行获取 access\_token调用时进入风险调用确认流程，需要用户管理员确认后才可以成功获取。具体流程为：

开发者通过某IP发起调用->平台返回错误码\[89503\]并同时下发模板消息给公众号管理员->公众号管理员确认该IP可以调用->开发者使用该IP再次发起调用->调用成功。

如公众号管理员第一次拒绝该IP调用，用户在1个小时内将无法使用该IP再次发起调用，如公众号管理员多次拒绝该IP调用，该IP将可能长期无法发起调用。平台建议开发者在发起调用前主动与管理员沟通确认调用需求，或请求管理员开启IP白名单功能并将该IP加入IP白名单列表。

公众号和小程序均可以使用AppID和AppSecret调用本接口来获取access\_token。AppID和AppSecret可在“微信公众平台-开发-基本配置”页中获得（需要已经成为开发者，且帐号没有异常状态）。\*\*调用接口时，请登录“微信公众平台-开发-基本配置”提前将服务器IP地址添加到IP白名单中，点击查看设置方法，否则将无法调用成功。\*\*小程序无需配置IP白名单。

接口调用请求说明

https请求方式: GET https://api.weixin.qq.com/cgi-bin/token?grant\_type=client\_credential&appid=APPID&secret=APPSECRET

参数说明

参数 是否必须 说明  
grant\_type 是 获取access\_token填写client\_credential  
appid 是 第三方用户唯一凭证  
secret 是 第三方用户唯一凭证密钥，即appsecret  
返回说明

正常情况下，微信会返回下述JSON数据包给公众号：

\{“access\_token”:“ACCESS\_TOKEN”,“expires\_in”:7200\}  
参数说明

参数 说明  
access\_token 获取到的凭证  
expires\_in 凭证有效时间，单位：秒  
错误时微信会返回错误码等信息，JSON数据包示例如下（该示例为AppID无效错误）:

\{“errcode”:40013,“errmsg”:“invalid appid”\}  
返回码说明

返回码 说明  
\-1 系统繁忙，此时请开发者稍候再试  
0 请求成功  
40001 AppSecret错误或者AppSecret不属于这个公众号，请开发者确认AppSecret的正确性  
40002 请确保grant\_type字段值为client\_credential  
40164 调用接口的IP地址不在白名单中，请在接口IP白名单中进行设置。（小程序及小游戏调用不要求IP地址在白名单内。）  
89503 此IP调用需要管理员确认,请联系管理员  
89501 此IP正在等待管理员确认,请联系管理员  
89506 24小时内该IP被管理员拒绝调用两次，24小时内不可再使用该IP调用  
89507 1小时内该IP被管理员拒绝调用一次，1小时内不可再使用该IP调用

**创建接口**  
自定义菜单能够帮助公众号丰富界面，让用户更好更快地理解公众号的功能。开启自定义菜单后，公众号界面如图所示：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMjI1NzI1_size_16_color_FFFFFF_t_70_pic_center]  
请注意：

自定义菜单最多包括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类型必须 小程序的页面路径  
返回结果

正确时的返回JSON数据包如下：

\{“errcode”:0,“errmsg”:“ok”\}  
错误时的返回JSON数据包如下（示例为无效菜单名长度）：

\{“errcode”:40018,“errmsg”:“invalid button name size”\}

![在这里插入图片描述][20201117152958440.png_pic_center]  
**HttpClientUtil**

package com.camel.ssm.util;
    
    import java.io.IOException;
    import java.net.URI;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Map;
    import org.apache.http.NameValuePair;
    import org.apache.http.client.entity.UrlEncodedFormEntity;
    import org.apache.http.client.methods.CloseableHttpResponse;
    import org.apache.http.client.methods.HttpGet;
    import org.apache.http.client.methods.HttpPost;
    import org.apache.http.client.utils.URIBuilder;
    import org.apache.http.entity.ContentType;
    import org.apache.http.entity.StringEntity;
    import org.apache.http.impl.client.CloseableHttpClient;
    import org.apache.http.impl.client.HttpClients;
    import org.apache.http.message.BasicNameValuePair;
    import org.apache.http.util.EntityUtils;
    /**
     * Created by Administrator on 2018/4/27.
     */
    public class HttpClientUtil {
    
    	public static String doGet(String url, Map<String, String> param) {
    
    		// 创建Httpclient对象
    		CloseableHttpClient httpclient = HttpClients.createDefault();
    
    		String resultString = "";
    		CloseableHttpResponse response = null;
    		try {
    			// 创建uri
    			URIBuilder builder = new URIBuilder(url);
    			if (param != null) {
    				for (String key : param.keySet()) {
    					builder.addParameter(key, param.get(key));
    				}
    			}
    			URI uri = builder.build();
    
    			// 创建http GET请求
    			HttpGet httpGet = new HttpGet(uri);
    
    			// 执行请求
    			response = httpclient.execute(httpGet);
    			// 判断返回状态是否为200
    			if (response.getStatusLine().getStatusCode() == 200) {
    				resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
    			}
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			try {
    				if (response != null) {
    					response.close();
    				}
    				httpclient.close();
    			} catch (IOException e) {
    				e.printStackTrace();
    			}
    		}
    		return resultString;
    	}
    
    	public static String doGet(String url) {
    		return doGet(url, null);
    	}
    
    	public static String doPost(String url, Map<String, String> param) {
    		// 创建Httpclient对象
    		CloseableHttpClient httpClient = HttpClients.createDefault();
    		CloseableHttpResponse response = null;
    		String resultString = "";
    		try {
    			// 创建Http Post请求
    			HttpPost httpPost = new HttpPost(url);
    			// 创建参数列表
    			if (param != null) {
    				List<NameValuePair> paramList = new ArrayList<>();
    				for (String key : param.keySet()) {
    					paramList.add(new BasicNameValuePair(key, param.get(key)));
    				}
    				// 模拟表单
    				UrlEncodedFormEntity entity = new UrlEncodedFormEntity(paramList,"utf-8");
    				httpPost.setEntity(entity);
    			}
    			// 执行http请求
    			response = httpClient.execute(httpPost);
    			resultString = EntityUtils.toString(response.getEntity(), "utf-8");
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			try {
    				response.close();
    			} catch (IOException e) {
    				// TODO Auto-generated catch block
    				e.printStackTrace();
    			}
    		}
    
    		return resultString;
    	}
    
    	public static String doPost(String createMenuUrl, String url) {
    		return doPost(url, (String) null);
    	}
    
    	public static String doPostJson(String url, String json) {
    		// 创建Httpclient对象
    		CloseableHttpClient httpClient = HttpClients.createDefault();
    		CloseableHttpResponse response = null;
    		String resultString = "";
    		try {
    			// 创建Http Post请求
    			HttpPost httpPost = new HttpPost(url);
    			// 创建请求内容
    			StringEntity entity = new StringEntity(json, ContentType.APPLICATION_JSON);
    			httpPost.setEntity(entity);
    			// 执行http请求
    			response = httpClient.execute(httpPost);
    			resultString = EntityUtils.toString(response.getEntity(), "utf-8");
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			try {
    				response.close();
    			} catch (IOException e) {
    				// TODO Auto-generated catch block
    				e.printStackTrace();
    			}
    		}
    
    		return resultString;
    	}
    }

**ArticleItem**

package com.camel.ssm.bean;
    
    import lombok.Getter;
    import lombok.Setter;
    
    import javax.xml.bind.annotation.XmlAccessType;
    import javax.xml.bind.annotation.XmlAccessorType;
    import javax.xml.bind.annotation.XmlRootElement;
    
    @Setter
    @Getter
    @XmlRootElement(name="xml")
    @XmlAccessorType(XmlAccessType.FIELD)
    public class ArticleItem {
        private String ToUserName;	//开发者微信号
        private String FromUserName;	//发送方帐号（一个OpenID）
        private Long CreateTime	;//消息创建时间 （整型）
        private String MsgType;	//消息类型，event
        private String Event;	//事件类型，subscribe(订阅)、unsubscribe(取消订阅/click)
        private String EventKey;	//事件KEY值，qrscene_为前缀，后面为二维码的参数值
    
    }

**InMsgEntity**

package com.camel.ssm.bean;
    
    
    import lombok.Getter;
    
    import javax.xml.bind.annotation.XmlAccessType;
    import javax.xml.bind.annotation.XmlAccessorType;
    import javax.xml.bind.annotation.XmlRootElement;
    
    /**
     * 接收普通消息
     */
    @XmlRootElement(name="xml")
    @XmlAccessorType(XmlAccessType.FIELD)
    
    public class InMsgEntity {
    // 如果要是小写的话 在每个字段都填上
    // @XmlRootElement(name="ToUserName")
    
       private String ToUserName;	//开发者微信号
        private String FromUserName;	//发送方帐号（一个OpenID）
        private Long CreateTime;	//消息创建时间 （整型）
        private String MsgType;	//消息类型，文本为text
        private String Content;	//文本消息内容
        private  Long MsgId;	//，64位整型
     private  String PicUrl;	//图片链接（由系统生成）
    
     // 图片消息媒体id，可以调用多媒体文件下载接口拉取数据
     private String MediaId;
     private String Format;	//语音格式，如amr，speex等
     private String Recognition;	//语音识别结果，UTF8编码
     private String ThumbMediaId;	//视频消息缩略图的媒体id，可以调用多媒体文件下载接口拉取数据。
     private String  Location_X;	//地理位置纬度
     private String Location_Y;	;//地理位置经度
     private String Scale;//	地图缩放大小
     private String Label;//	地理位置信息
     private String Title;//	消息标题
     private String Description;//	消息描述
     private String Url;//	消息链接
    
     public String getToUserName() {
      return ToUserName;
     }
    
     public void setToUserName(String toUserName) {
      ToUserName = toUserName;
     }
    
     public String getFromUserName() {
      return FromUserName;
     }
    
     public void setFromUserName(String fromUserName) {
      FromUserName = fromUserName;
     }
    
     public Long getCreateTime() {
      return CreateTime;
     }
    
     public void setCreateTime(Long createTime) {
      CreateTime = createTime;
     }
    
     public String getMsgType() {
      return MsgType;
     }
    
     public void setMsgType(String msgType) {
      MsgType = msgType;
     }
    
     public String getContent() {
      return Content;
     }
    
     public void setContent(String content) {
      Content = content;
     }
    
     public Long getMsgId() {
      return MsgId;
     }
    
     public void setMsgId(Long msgId) {
      MsgId = msgId;
     }
    
     public String getPicUrl() {
      return PicUrl;
     }
    
     public void setPicUrl(String picUrl) {
      PicUrl = picUrl;
     }
    
     public String getMediaId() {
      return MediaId;
     }
    
     public void setMediaId(String mediaId) {
      MediaId = mediaId;
     }
    
     public String getFormat() {
      return Format;
     }
    
     public void setFormat(String format) {
      Format = format;
     }
    
     public String getRecognition() {
      return Recognition;
     }
    
     public void setRecognition(String recognition) {
      Recognition = recognition;
     }
    
     public String getThumbMediaId() {
      return ThumbMediaId;
     }
    
     public void setThumbMediaId(String thumbMediaId) {
      ThumbMediaId = thumbMediaId;
     }
    
     public String getLocation_X() {
      return Location_X;
     }
    
     public void setLocation_X(String location_X) {
      Location_X = location_X;
     }
    
     public String getLocation_Y() {
      return Location_Y;
     }
    
     public void setLocation_Y(String location_Y) {
      Location_Y = location_Y;
     }
    
     public String getScale() {
      return Scale;
     }
    
     public void setScale(String scale) {
      Scale = scale;
     }
    
     public String getLabel() {
      return Label;
     }
    
     public void setLabel(String label) {
      Label = label;
     }
    
     public String getTitle() {
      return Title;
     }
    
     public void setTitle(String title) {
      Title = title;
     }
    
     public String getDescription() {
      return Description;
     }
    
     public void setDescription(String description) {
      Description = description;
     }
    
     public String getUrl() {
      return Url;
     }
    
     public void setUrl(String url) {
      Url = url;
     }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMjI1NzI1_size_16_color_FFFFFF_t_70_pic_center 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMjI1NzI1_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/b82f3a72d8f74d71bf7d0d37d753546a.png
[20201117152958440.png_pic_center]: /images/20221120/b96cda1aaec84456a5fd8e7e9928e81d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMjI1NzI1_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/3f0dcb3a805e46e095168fa0be60e49e.png