menu.py 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. # -*- coding: utf-8 -*-
  2. from __future__ import absolute_import, unicode_literals
  3. from library.wechatbase.exceptions import WeChatException
  4. from library.wechatpy.client.api.base import BaseWeChatAPI
  5. class WeChatMenu(BaseWeChatAPI):
  6. def get(self):
  7. """
  8. 查询自定义菜单。
  9. 详情请参考
  10. http://mp.weixin.qq.com/wiki/16/ff9b7b85220e1396ffa16794a9d95adc.html
  11. :return: 返回的 JSON 数据包
  12. 使用示例::
  13. from wechatpy import WeChatClient
  14. client = WeChatClient('appid', 'secret')
  15. menu = client.menu.get()
  16. """
  17. try:
  18. return self._get('menu/get')
  19. except WeChatException as e:
  20. if e.errCode == 46003:
  21. # menu not exist
  22. return None
  23. else:
  24. raise e
  25. def create(self, menu_data):
  26. """
  27. 创建自定义菜单 ::
  28. from wechatpy import WeChatClient
  29. client = WeChatClient("appid", "secret")
  30. client.menu.create({
  31. "button":[
  32. {
  33. "type":"click",
  34. "name":"今日歌曲",
  35. "key":"V1001_TODAY_MUSIC"
  36. },
  37. {
  38. "type":"click",
  39. "name":"歌手简介",
  40. "key":"V1001_TODAY_SINGER"
  41. },
  42. {
  43. "name":"菜单",
  44. "sub_button":[
  45. {
  46. "type":"view",
  47. "name":"搜索",
  48. "url":"http://www.soso.com/"
  49. },
  50. {
  51. "type":"view",
  52. "name":"视频",
  53. "url":"http://v.qq.com/"
  54. },
  55. {
  56. "type":"click",
  57. "name":"赞一下我们",
  58. "key":"V1001_GOOD"
  59. }
  60. ]
  61. }
  62. ]
  63. })
  64. 详情请参考
  65. https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141013
  66. :param menu_data: Python 字典
  67. :return: 返回的 JSON 数据包
  68. """
  69. return self._post(
  70. 'menu/create',
  71. data=menu_data
  72. )
  73. def update(self, menu_data):
  74. """
  75. 更新自定义菜单 ::
  76. from wechatpy import WeChatClient
  77. client = WeChatClient("appid", "secret")
  78. client.menu.update({
  79. "button":[
  80. {
  81. "type":"click",
  82. "name":"今日歌曲",
  83. "key":"V1001_TODAY_MUSIC"
  84. },
  85. {
  86. "type":"click",
  87. "name":"歌手简介",
  88. "key":"V1001_TODAY_SINGER"
  89. },
  90. {
  91. "name":"菜单",
  92. "sub_button":[
  93. {
  94. "type":"view",
  95. "name":"搜索",
  96. "url":"http://www.soso.com/"
  97. },
  98. {
  99. "type":"view",
  100. "name":"视频",
  101. "url":"http://v.qq.com/"
  102. },
  103. {
  104. "type":"click",
  105. "name":"赞一下我们",
  106. "key":"V1001_GOOD"
  107. }
  108. ]
  109. }
  110. ]
  111. })
  112. 详情请参考
  113. https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141013
  114. :param menu_data: Python 字典
  115. :return: 返回的 JSON 数据包
  116. """
  117. return self.create(menu_data)
  118. def delete(self):
  119. """
  120. 删除自定义菜单。
  121. 详情请参考
  122. http://mp.weixin.qq.com/wiki/16/8ed41ba931e4845844ad6d1eeb8060c8.html
  123. :return: 返回的 JSON 数据包
  124. 使用示例::
  125. from wechatpy import WeChatClient
  126. client = WeChatClient('appid', 'secret')
  127. res = client.menu.delete()
  128. """
  129. return self._get('menu/delete')
  130. def get_menu_info(self):
  131. """
  132. 获取自定义菜单配置
  133. 详情请参考
  134. http://mp.weixin.qq.com/wiki/17/4dc4b0514fdad7a5fbbd477aa9aab5ed.html
  135. :return: 返回的 JSON 数据包
  136. 使用示例::
  137. from wechatpy import WeChatClient
  138. client = WeChatClient('appid', 'secret')
  139. menu_info = client.menu.get_menu_info()
  140. """
  141. return self._get('get_current_selfmenu_info')
  142. def add_conditional(self, menu_data):
  143. """
  144. 创建个性化菜单 ::
  145. from wechatpy import WeChatClient
  146. client = WeChatClient("appid", "secret")
  147. client.menu.add_conditional({
  148. "button":[
  149. {
  150. "type":"click",
  151. "name":"今日歌曲",
  152. "key":"V1001_TODAY_MUSIC"
  153. },
  154. {
  155. "type":"click",
  156. "name":"歌手简介",
  157. "key":"V1001_TODAY_SINGER"
  158. },
  159. {
  160. "name":"菜单",
  161. "sub_button":[
  162. {
  163. "type":"view",
  164. "name":"搜索",
  165. "url":"http://www.soso.com/"
  166. },
  167. {
  168. "type":"view",
  169. "name":"视频",
  170. "url":"http://v.qq.com/"
  171. },
  172. {
  173. "type":"click",
  174. "name":"赞一下我们",
  175. "key":"V1001_GOOD"
  176. }
  177. ]
  178. }
  179. ],
  180. "matchrule":{
  181. "group_id":"2",
  182. "sex":"1",
  183. "country":"中国",
  184. "province":"广东",
  185. "city":"广州",
  186. "client_platform_type":"2"
  187. }
  188. })
  189. 详情请参考
  190. http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
  191. :param menu_data: Python 字典
  192. :return: 返回的 JSON 数据包
  193. """
  194. return self._post(
  195. 'menu/addconditional',
  196. data=menu_data
  197. )
  198. def del_conditional(self, menu_id):
  199. """
  200. 删除个性化菜单
  201. 详情请参考
  202. http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
  203. :param menu_id: 菜单ID
  204. :return: 返回的 JSON 数据包
  205. 使用示例::
  206. from wechatpy import WeChatClient
  207. client = WeChatClient('appid', 'secret')
  208. res = client.menu.del_conditional('menu_id')
  209. """
  210. return self._post(
  211. 'menu/delconditional',
  212. data={'menuid': menu_id}
  213. )
  214. def try_match(self, user_id):
  215. """
  216. 测试个性化菜单匹配结果
  217. 详情请参考
  218. http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
  219. :param user_id: 可以是粉丝的OpenID,也可以是粉丝的微信号。
  220. :return: 该接口将返回菜单配置
  221. 使用示例::
  222. from wechatpy import WeChatClient
  223. client = WeChatClient('appid', 'secret')
  224. res = client.menu.try_match('openid')
  225. """
  226. return self._post(
  227. 'menu/trymatch',
  228. data={'user_id': user_id}
  229. )