本接口將會提供公眾號當前使用的自定義菜單的配置,如果公眾號是通過API調用設置的菜單,則返回菜單的開發配置,而如果公眾號是在公眾平臺官網通過網站功能發布菜單,則本接口返回運營者設置的菜單配置。
請注意:
- 第三方平臺開發者可以通過本接口,在旗下公眾號將業務授權給你后,立即通過本接口檢測公眾號的自定義菜單配置,并通過接口再次給公眾號設置好自動回復規則,以提升公眾號運營者的業務體驗。
- 本接口與自定義菜單查詢接口的不同之處在于,本接口無論公眾號的接口是如何設置的,都能查詢到接口,而自定義菜單查詢接口則僅能查詢到使用API設置的菜單配置。
- 認證/未認證的服務號/訂閱號,以及接口測試號,均擁有該接口權限。
- 從第三方平臺的公眾號登錄授權機制上來說,該接口從屬于消息與菜單權限集。
- 本接口中返回的圖片/語音/視頻為臨時素材(臨時素材每次獲取都不同,3天內有效,通過素材管理-獲取臨時素材接口來獲取這些素材),本接口返回的圖文消息為永久素材素材(通過素材管理-獲取永久素材接口來獲取這些素材)。
接口調用請求說明
http請求方式: GET(請使用https協議)https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info?access_token=ACCESS_TOKEN
返回結果說明
如果公眾號是在公眾平臺官網通過網站功能發布菜單,則本接口返回的自定義菜單配置樣例如下:
{
"is_menu_open": 1,
"selfmenu_info": {
"button": [
{
"name": "button",
"sub_button": {
"list": [
{
"type": "view",
"name": "view_url",
"url": "http://www.qq.com"
},
{
"type": "news",
"name": "news",
"value":"KQb_w_Tiz-nSdVLoTV35Psmty8hGBulGhEdbb9SKs-o",
"news_info": {
"list": [
{
"title": "MULTI_NEWS",
"author": "JIMZHENG",
"digest": "text",
"show_cover": 0,
"cover_url": "http://mmbiz.qpic.cn/mmbiz/GE7et87vE9vicuCibqXsX9GPPLuEtBfXfK0HKuBIa1A1cypS0uY1wickv70iaY1gf3I1DTszuJoS3lAVLvhTcm9sDA/0",
"content_url": "http://mp.weixin.qq.com/s?__biz=MjM5ODUwNTM3Ng==&mid=204013432&idx=1&sn=80ce6d9abcb832237bf86c87e50fda15#rd",
"source_url": ""
},
{
"title": "MULTI_NEWS1",
"author": "JIMZHENG",
"digest": "MULTI_NEWS1",
"show_cover": 1,
"cover_url": "http://mmbiz.qpic.cn/mmbiz/GE7et87vE9vicuCibqXsX9GPPLuEtBfXfKnmnpXYgWmQD5gXUrEApIYBCgvh2yHsu3ic3anDUGtUCHwjiaEC5bicd7A/0",
"content_url": "http://mp.weixin.qq.com/s?__biz=MjM5ODUwNTM3Ng==&mid=204013432&idx=2&sn=8226843afb14ecdecb08d9ce46bc1d37#rd",
"source_url": ""
}
]
}
},
{
"type": "video",
"name": "video",
"value": "http://61.182.130.30/vweixinp.tc.qq.com/1007_114bcede9a2244eeb5ab7f76d951df5f.f10.mp4?vkey=77A42D0C2015FBB0A3653D29C571B5F4BBF1D243FBEF17F09C24FF1F2F22E30881BD350E360BC53F&sha=0&save=1"
},
{
"type": "voice",
"name": "voice",
"value": "nTXe3aghlQ4XYHa0AQPWiQQbFW9RVtaYTLPC1PCQx11qc9UB6CiUPFjdkeEtJicn"
}
]
}
},
{
"type": "text",
"name": "text",
"value": "This is text!"
},
{
"type": "img",
"name": "photo",
"value": "ax5Whs5dsoomJLEppAvftBUuH7CgXCZGFbFJifmbUjnQk_ierMHY99Y5d2Cv14RD"
}
]
}
}
如果公眾號是通過API調用設置的菜單,自定義菜單配置樣例如下:
{
"is_menu_open": 1,
"selfmenu_info": {
"button": [
{
"type": "click",
"name": "今日歌曲",
"key": "V1001_TODAY_MUSIC"
},
{
"name": "菜單",
"sub_button": {
"list": [
{
"type": "view",
"name": "搜索",
"url": "http://www.soso.com/"
},
{
"type": "view",
"name": "視頻",
"url": "http://v.qq.com/"
},
{
"type": "click",
"name": "贊一下我們",
"key": "V1001_GOOD"
}
]
}
}
]
}
}
參數說明
參數 | 說明 |
---|---|
is_menu_open | 菜單是否開啟,0代表未開啟,1代表開啟 |
selfmenu_info | 菜單信息 |
button | 菜單按鈕 |
type | 菜單的類型,公眾平臺官網上能夠設置的菜單類型有view(跳轉網頁)、text(返回文本,下同)、img、photo、video、voice。使用API設置的則有8種,詳見《自定義菜單創建接口》 |
name | 菜單名稱 |
value、url、key等字段 | 對于不同的菜單類型,value的值意義不同。官網上設置的自定義菜單: Text:保存文字到value; Img、voice:保存mediaID到value; Video:保存視頻下載鏈接到value; News:保存圖文消息到news_info,同時保存mediaID到value; View:保存鏈接到url。 使用API設置的自定義菜單: click、scancode_push、scancode_waitmsg、pic_sysphoto、pic_photo_or_album、 pic_weixin、location_select:保存值到key;view:保存鏈接到url |
news_info | 圖文消息的信息 |
title | 圖文消息的標題 |
digest | 摘要 |
author | 作者 |
show_cover | 是否顯示封面,0為不顯示,1為顯示 |
cover_url | 封面圖片的URL |
content_url | 正文的URL |
source_url | 原文的URL,若置空則無查看原文入口 |