微信自定義菜單接口

簡介

開發者獲取使用憑證（如何獲取憑證）後，可以使用該憑證對公眾賬號的自定義菜單進行創建、查詢和刪除等操作。 自定義菜單接口可實現以下類型按鈕：

click（點擊事件）：

用戶點擊click類型按鈕後，微信服務器會通過消息接口(event類型)推送點擊事件給開發者，並且帶上按鈕中開發者填寫的key值，開發者可以通過自定義的key值進行消息回復。

view（訪問網頁）：

用戶點擊view類型按鈕後，會直接跳轉到開發者指定的url中。

創建自定義菜單後，由於微信客戶端緩存，需要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":"view",
           "name":"歌手簡介",
           "url":"http://www.bkjia.com/"
      },
      {
           "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"}