自定义菜单创建接口

出自中南e行公众平台开发者文档
跳转到： 导航, 搜索

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

菜单.jpg

目前自定义菜单最多包括3个一级菜单，每个一级菜单最多包含5个二级菜单。一级菜单最多4个汉字，二级菜单最多7个汉字，多出来的部分将会以“...”代替。建议测试时可以尝试取消关注公众账号后再次关注，则可以看到创建后的效果。

自定义菜单接口可实现多种类型按钮，如下： 

1、click：点击推事件
用户点击click类型按钮后，中南e行服务器会通过消息接口推送消息类型为event	的结构给开发者（参考消息接口指南），并且带上按钮中开发者填写的key值，开发者可以通过自定义的key值与用户进行交互；
2、view：跳转URL
用户点击view类型按钮后，中南e行客户端将会打开开发者在按钮中填写的网页URL，可与网页授权获取用户基本信息接口结合，获得用户基本信息。
3、scancode_push：扫码推事件
用户点击按钮后，中南e行客户端将调起扫一扫工具，完成扫码操作后显示扫描结果（如果是URL，将进入URL），且会将扫码的结果传给开发者，开发者可以下发消息。


接口调用请求说明

http请求方式：POST（请使用http协议） http://app.its.csu.edu.cn/mqtt/cgi-bin/menu/create?access_token=ACCESS_TOKEN&user_type=USER_TYPE

GET参数说明(新增)

user_type:中南e行支持高级模式的自定义菜单，通过user_type字段来区分。当user_type参数不传或设置为”A”时，则是创建普通模式的菜单列表。
当user_type参数传”S”或”T”时，则是分别创建学生或老师的菜单。

说明：当调用接口指定用户类型为学生或老师时，自动开启高级模式，原有普通模式的菜单将会被删除。同理，当调用接口指定用户类型为”A”或不传用户类型时，则会把高级模式的学生与老师菜单删除。
学生和老师的菜单可同时存在，但需要分别创建。但普通模式菜单与高级模式菜单不能同时存在。

click和view的请求示例 

 {
     "button":[
     {	
          "type":"click",
          "name":"今日歌曲",
          "key":"V1001_TODAY_MUSIC"
      },
      {
           "name":"菜单",
           "sub_button":[
           {	
               "type":"view",
               "name":"搜索",
               "url":"http://www.csu.com/"
            },
            {
               "type":"view",
               "name":"新闻",
               "url":"http://v.csu.com/"
            },
            {
               "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": "中南e行相册发图", 
                    "key": "rselfmenu_1_2", 
                    "sub_button": [ ]
                }
            ]
        }, 
        {
            "name": "发送位置", 
            "type": "location_select", 
            "key": "rselfmenu_2_0"
        }
    ]
}

参数说明

参数 是否必须 说明
button 是 一级菜单数组，个数应为1~3个
sub_button 否 二级菜单数组，个数应为1~5个
type 是 菜单的响应动作类型
name 是 菜单标题，不超过16个字节，子菜单不超过40个字节
key click等点击类型必须 菜单KEY值，用于消息接口推送，不超过128字节
url view类型必须 网页链接，用户点击菜单可打开链接，不超过256字节


返回结果

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

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

错误时的返回JSON数据包如下（示例为无效菜单名长度）： 

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

全局返回码说明

使用网页调试工具调试该接口

取自“../6/95cade7d98b6c1e1040cde5d9a2f9c26.html”