微信公眾平臺開發模式自定義菜單接口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"}
責任編輯：徐川
來源：
微信
