微信企業號開發之如何使用自定義菜單
企業號的每個應用都可以擁有自己的菜單,企業可以調用接口來創建、刪除、獲取應用菜單。
注意,在操作應用的菜單時,應用必須處于回調模式;菜單最多為兩級,一級菜單最多為3個,二級菜單最多為5個。
一、創建應用菜單
- 請求說明
Https請求方式: POST
https://qyapi.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN&agentid=1
請求包如下:
- {
- "button":[
- {
- "type":"click",
- "name":"今日歌曲",
- "key":"V1001_TODAY_MUSIC"
- },
- {
- "name":"菜單",
- "sub_button":[
- {
- "type":"view",
- "name":"搜索",
- "url":"http://www.soso.com/"
- },
- {
- "type":"click",
- "name":"贊一下我們",
- "key":"V1001_GOOD"
- }
- ]
- }
- ]
- }
- 參數說明
參數 | 必須 | 說明 |
---|---|---|
access_token | 是 | 調用接口憑證 |
agentid | 是 | 企業應用的id,整型??稍趹玫脑O置頁面查看 |
button | 是 | 一級菜單數組,個數應為1~3個 |
sub_button | 否 | 二級菜單數組,個數應為1~5個 |
type | 是 | 菜單的響應動作類型,目前有click、view兩種類型 |
name | 是 | 菜單標題,不超過16個字節,子菜單不超過40個字節 |
key | click類型必須 | 菜單KEY值,用于消息接口推送,不超過128字節 |
url | view類型必須 | 網頁鏈接,員工點擊菜單可打開鏈接,不超過256字節 |
- 權限說明
管理員須擁有應用的管理權限,并且應用必須設置在回調模式。
返回結果
- {
- "errcode":0,
- "errmsg":"ok"
- }
二、刪除菜單
- 請求說明
Https請求方式:GET
https://qyapi.weixin.qq.com/cgi-bin/menu/delete?access_token=ACCESS_TOKEN&agentid=1
- 參數說明
參數 | 必須 | 說明 |
---|---|---|
access_token | 是 | 調用接口憑證 |
agentid | 是 | 企業應用的id,整型。可在應用的設置頁面查看 |
- 權限說明
管理員須擁有應用的管理權限,并且應用必須設置在回調模式。
- 返回結果
- {
- "errcode":0,
- "errmsg":"ok"
- }
三、獲取菜單列表
- 請求說明
Https請求方式:GET
https://qyapi.weixin.qq.com/cgi-bin/menu/get?access_token=ACCESS_TOKEN&agentid=1
- 參數說明
參數 | 必須 | 說明 |
---|---|---|
access_token | 是 | 調用接口憑證 |
agentid | 是 | 企業應用的id,整型。可在應用的設置頁面查看 |
- 權限說明
管理員須擁有應用的管理權限,并且應用必須設置在回調模式。
- 返回結果
返回結果與菜單創建的參數一致。