wechatpy / wechatpy

WeChat SDK for Python

  ___       __   _______   ________  ___  ___  ________  _________  ________  ___    ___
 |\  \     |\  \|\  ___ \ |\   ____\|\  \|\  \|\   __  \|\___   ___\\   __  \|\  \  /  /|
 \ \  \    \ \  \ \   __/|\ \  \___|\ \  \\\  \ \  \|\  \|___ \  \_\ \  \|\  \ \  \/  / /
  \ \  \  __\ \  \ \  \_|/_\ \  \    \ \   __  \ \   __  \   \ \  \ \ \   ____\ \    / /
   \ \  \|\__\_\  \ \  \_|\ \ \  \____\ \  \ \  \ \  \ \  \   \ \  \ \ \  \___|\/  /  /
    \ \____________\ \_______\ \_______\ \__\ \__\ \__\ \__\   \ \__\ \ \__\ __/  / /
     \|____________|\|_______|\|_______|\|__|\|__|\|__|\|__|    \|__|  \|__||\___/ /
                                                                            \|___|/

微信(WeChat) 公众平台第三方 Python SDK。

v1.x: 【阅读文档】 【快速入门】 master: 【阅读文档】 【快速入门】

功能特性

1. 普通公众平台被动响应和主动调用 API
2. 企业微信 API
3. 微信支付 API
4. 第三方平台代公众号调用接口 API
5. 小程序云开发 API

安装

推荐使用 pip 进行安装:

pip install wechatpy

升级版本：

pip install -U wechatpy

使用示例

使用示例参见 examples

贡献代码

请阅读 贡献代码指南

支持项目

如果觉得本项目对您有帮助，请考虑捐赠支持项目开发

问题反馈

我们主要使用 GitHub issues 进行问题追踪和反馈。

QQ 群：176596300

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

This work is released under the MIT license. A copy of the license is provided in the LICENSE file.

wechatpy's Issues

高级群发接口

http://mp.weixin.qq.com/wiki/index.php?title=%E9%AB%98%E7%BA%A7%E7%BE%A4%E5%8F%91%E6%8E%A5%E5%8F%A3

企业号邀请成员关注接口

邀请成员关注

客服发消息接口

http://mp.weixin.qq.com/wiki/1/70a29afed17f56d537c833f89be979c9.html#.E5.AE.A2.E6.9C.8D.E6.8E.A5.E5.8F.A3-.E5.8F.91.E6.B6.88.E6.81.AF

图文消息回复时图文个数一直在递增

if isinstance(message, TextMessage):
            print u'文本消息'
            reply = ArticlesReply(message=message)
            reply.add_article({
                'title': '猫',
                'description': '描述文字……',
                'image': 'http://a.hiphotos.baidu.com/image/w%3D310/sign=595a29f639c79f3d8fe1e2318aa0cdbc/43a7d933c895d1433d2c882a71f082025aaf0764.jpg',
                'url': 'http://www.baidu.com'
            })
            return HttpResponse(reply, mimetype='application/javascript')

客服删除还有错

删除接口最后访问的链接为:
https://api.weixin.qq.com/customservice/kfaccount/del?access_token=xxxxxxxxx&kf_account=aa11111%5C%40wiicome

requests自动编码符号@为%40,然后就报错了:无效客服账号(invalid kf_account)

多客服功能

http://mp.weixin.qq.com/wiki/index.php?title=%E5%B0%86%E6%B6%88%E6%81%AF%E8%BD%AC%E5%8F%91%E5%88%B0%E5%A4%9A%E5%AE%A2%E6%9C%8D

设置用户备注名 API

http://mp.weixin.qq.com/wiki/index.php?title=%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%A4%87%E6%B3%A8%E5%90%8D%E6%8E%A5%E5%8F%A3

OAuth授权中的检验授权凭证（access_token）是否有效 中的URL错误

/wechatpy/oauth.py 162行

sns/oauth2/auth应改为sns/auth

微信官方资料

模版群发消息事件推送msg.id没有

模版消息事件推送过来msg.id没有

模版消息,群发消息的推送:
<MsgID>200163840</MsgID>
文本消息的推送:
<MsgId>1234567890123456</MsgId>

原来的:
class BaseMessage(six.with_metaclass(MessageMetaClass)):
    """Base class for all messages and events"""
    type = 'unknown'
    id = IntegerField('MsgId', 0)
event加一行id:
class BaseEvent(BaseMessage):
    """Base class for all events"""
    id = IntegerField('MsgID', 0)
    type = 'event'
    event = ''

这样改可以吗

模板消息接口

http://mp.weixin.qq.com/wiki/index.php?title=%E6%A8%A1%E6%9D%BF%E6%B6%88%E6%81%AF%E6%8E%A5%E5%8F%A3

windows 下用 pip 安装报错

Log 如下，Python 3.4。为什么会用到 Visual C++？如果一定要的话，那怎样才能部署到服务器上去呢？刚开始学习，请多指教

creating build\lib.win32-3.4\Crypto\Signature
copying lib\Crypto\Signature\PKCS1_v1_5.py -> build\lib.win32-3.4\Crypto\Signature
copying lib\Crypto\Signature\__init__.py -> build\lib.win32-3.4\Crypto\Signature

Skipping implicit fixer: buffer
Skipping implicit fixer: idioms
Skipping implicit fixer: set_literal

Skipping implicit fixer: ws_comma
running build_ext
building 'Crypto.Random.OSRNG.winrandom' extension
warning: GMP or MPIR library not found; Not building Crypto.PublicKey._fastmath.
error: Microsoft Visual C++ 10.0 is required (Unable to find vcvarsall.bat).
----------------------------------------

关于客服创建会话 503 Server Error: Service Unavailable

customservice.create_session(self.msg.source, u"test@test", text=None)

微信支付接口

https://mp.weixin.qq.com/paymch/readtemplate?t=mp/business/course2_tmpl

多客服会话控制接口

http://mp.weixin.qq.com/wiki/2/6c20f3e323bdf5986cfcb33cbd3b829a.html

群发视频上传报错

报错信息

SSLError: hostname 'file.api.weixin.qq.com' doesn't match either of 'game.weixin.qq.com', 'long.open.weixin.qq.com', 'open.weixin.qq.com', 'api.weixin.qq.com', 'a.weixin.qq.com', 'mp.weixinbridge.com', 'mp.weixin.qq.com'

调用此接口时出错
https://file.api.weixin.qq.com/cgi-bin/media/uploadvideo?access_token=ACCESS_TOKEN
好像是证书问题
http://cn.python-requests.org/en/latest/user/advanced.html#ssl

语意理解 API

http://mp.weixin.qq.com/wiki/0/0ce78b3c9524811fee34aba3e33f3448.html

用户分组管理有新增了删除分组

望有空再看下,加进项目里
我试过,一直删除失败 -1 系统繁忙

企业号我用这代码回调没反应啊

from __future__ import absolute_import, unicode_literals
from flask import Flask, request, abort, make_response
from wechatpy.enterprise.crypto import WeChatCrypto
from wechatpy.exceptions import InvalidSignatureException
from wechatpy.enterprise.exceptions import InvalidCorpIdException
from wechatpy.enterprise import parse_message, create_reply


TOKEN = '123456'
EncodingAESKey = ''
CorpId = ''

app = Flask(__name__)


@app.route('/wechat', methods=['GET', 'POST'])
def wechat():
    signature = request.args.get('msg_signature', '')
    timestamp = request.args.get('timestamp', '')
    nonce = request.args.get('nonce', '')

    crypto = WeChatCrypto(TOKEN, EncodingAESKey, CorpId)
    if request.method == 'GET':
        echo_str = request.args.get('echostr', '')
        try:
            echo_str = crypto.check_signature(
                signature,
                timestamp,
                nonce,
                echo_str
            )
        except InvalidSignatureException:
            abort(403)
        return echo_str
    else:
        try:
            msg = crypto.decrypt_message(
                request.data,
                signature,
                timestamp,
                nonce
            )
        except (InvalidSignatureException, InvalidCorpIdException):
            abort(403)
        msg = parse_message(msg)
        if msg.type == 'text':
            reply = create_reply(msg.content, msg).render()
        else:
            reply = create_reply('Can not handle this for now', msg).render()
        res = make_response(crypto.encrypt_message(reply, nonce, timestamp))
        res.headers['Content-Type'] = 'application/xml'
        return res


if __name__ == '__main__':
    app.run('127.0.0.1', 5001, debug=True)

企业号异步任务接口

http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BC%82%E6%AD%A5%E4%BB%BB%E5%8A%A1%E6%8E%A5%E5%8F%A3

企业号批量获取部门成员接口

批量获取部门成员

企业平台第三方应用接口 API

https://work.weixin.qq.com/api/doc#10968

自定义菜单事件推送

http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E4%BA%8B%E4%BB%B6%E6%8E%A8%E9%80%81

摇一摇周边接口

http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

企业号批量删除用户接口

批量删除

关于发送模板消息的问题

下面的"TM00015" 是否要手动获取模板ID，请问在wechatpy API 中没有获取模板ID的封装接口吗？

一下代码返回错误码：Error code: 40037, message: invalid template_id
client.message.send_template(open_id, "TM00015", "http://127.0.0.1:5000/", "#FF0000",
{
"first": {
"value": u"恭喜您下单成功！",
"color": "#173177"
},
"orderMoneySum": {
"value": u"10000",
"color": "#173177"
},
"orderProductName": {
"value": u"这是商品名",
"color": "#173177"
},
"remark": {
"value": u"欢迎再次购买！",
"color": "#173177"
}
})

上传图片时，关于file object问题，新人求解答。

weMedia = WeChatMedia(client)
fo = open("E:\hh.jpg", 'rb+')
try:
    imageJson = weMedia.upload('image', fo )
finally:
    pass

报错I/O operation on closed file

微信小店接口

http://mp.weixin.qq.com/wiki/index.php?title=%E5%BE%AE%E4%BF%A1%E5%B0%8F%E5%BA%97%E6%8E%A5%E5%8F%A3

遇到了一些问题

1. 图片消息缺少 media_id
2. 下载多媒体文件时，返回的不是 json，应该是文件 stream，对应的 requests 中应该是 r.content，

以上均在企业号中使用遇到的问题

PS：真是想不明白为什么『弹出系统拍照发图的事件推送』这个事件中微信不返回图片的 media_id，而是图片的 md5。

还有一个问题是『弹出拍照或者相册发图的事件推送』，在选择相册图片后，微信没有按照它规定的格式发过来 count 和 PicList，发过来的 PicList 为空，并且 count 为 0，造成了wechatpy 解析消息后得到的 PicList 为 None

找不到 create_menu 方法

你好，又来请教。

我在使用 client.py 去创建菜单的时候，总提示找不到任何定义的方法，比如 create_menu, send_text_message 等。

代码如下：

from wechatpy import WeChatClient

client = WeChatClient(APPID, AESKEY)
print(client.API_BASE_URL)
client.send_text_message(TOKEN,"123456")

提示
AttributeError: 'WeChatClient' object has no attribute 'send_text_message'

如何把 send_text_message 换成 WeChatClient 的其他方法，也会出现相应的错误 。但是 API_BASE_URL 是可以找到的。请帮忙。谢谢

继承了 WeChatClient，但是 __new__ 并没有正确的执行

Hi,
我继承了 WeChatClient，重写了 init，access_token，fetch_access_token 这三个方法，但是我发现 BaseWeChatClient 的 new 并没有正确的执行，导致 api._client 为 None

我尝试在继承的类中手动执行 WeChatClient.new 也没有用

sae环境部署的时候出现如下错误，哪位高手能指点一二，谢谢

Traceback (most recent call last):
File "/data1/www/htdocs/196/flyzhu/4/index.wsgi", line 4, in
from myapp import app
File "/data1/www/htdocs/196/flyzhu/4/myapp.py", line 10, in
from wechatpy.enterprise.crypto import WeChatCrypto
File "/data1/www/htdocs/196/flyzhu/4/site-packages/wechatpy/enterprise/init.py", line 5, in
from .crypto import WeChatCrypto # NOQA
File "/data1/www/htdocs/196/flyzhu/4/site-packages/wechatpy/enterprise/crypto.py", line 12, in
from Crypto.Cipher import AES
File "/data1/www/htdocs/196/flyzhu/4/site-packages/Crypto/Cipher/AES.py", line 50, in
from Crypto.Cipher import _AES
ImportError: cannot import name _AES

回复音乐消息报错

代码

reply = MusicReply(music=message.media_id, 
                               thumb_media_id='YS4DH6hXNLgkcuOUVFFDmlr8A9tngYL5zak0k6CSrQGDG6fc_pHKG57Cmmou8h_m',
                               title=u'音乐回复测试', description='description',
                               music_url='http://sc1.111ttt.com/2015/6/04/11/97111815180.mp3',
                               hq_music_url='http://sc1.111ttt.com/2015/6/04/11/97111815180.mp3',
                               message=message)

报错信息

AttributeError: Unknown argument: thumb_media_id

回复视频消息也有

AttributeError: Unknown argument: title

回复文章报错

#这是调用的地方相关的几句
articles = [
            {
                'title':u'test',
                'description': u'test',
                'image': 'http://www.test.com/logo_s2.png',
                'url': "http://www.test.com/"
            }
        ]
reply = create_reply(articles, message=msg)
return reply.render()

#报错信息
root.py", line 60, in wechat
    return reply.render()
python2.7/site-packages/wechatpy/replies.py", line 73, in render
    node_xml = field.to_xml(value)
python2.7/site-packages/wechatpy/fields.py", line 172, in to_xml
    title = self.converter(article.get('title', ''))
AttributeError: 'unicode' object has no attribute 'get'

我追查了下，传进去的articles本来是个list,但是被存到self._fields里之后就变成了unicode了，取出来再get自然就报错。不止article，其他传入list的回复类型也会报错。
不知道如何从根本解决，我这样临时改了包里的源码，你看了就理解我的意思了：

def render(self):
        """Render reply from Python object to XML string"""
        tpl = '<xml>\n{data}\n</xml>'
        nodes = []
        msg_type = '<MsgType><![CDATA[{msg_type}]]></MsgType>'.format(
            msg_type=self.type
        )
        nodes.append(msg_type)
        for name, field in self._fields.items():
            value = getattr(self, name, field.default)
            #========我加的=========
            if name == 'articles':
                try:
                    value = eval(value)
                except Exception,exp:
                    pass
            #========我加的END=========
            node_xml = field.to_xml(value)
            nodes.append(node_xml)
        data = '\n'.join(nodes)
        return tpl.format(data=data)

望尽快解决~~~

设备功能接口

http://iot.weixin.qq.com/

今天从 0.6.3 升级到 0.8 时发现 API 接口变了

企业号获取微信服务器的 ip 段接口

获取微信服务器的 ip 段接口

请问有对菜单的支持封装么？

如题

客服管理 API

http://mp.weixin.qq.com/wiki/9/6fff6f191ef92c126b043ada035cc935.html

微信门店接口

http://mp.weixin.qq.com/wiki/16/8f182af4d8dcea02c56506306bdb2f4c.html

WeChat enterprise APIs

微信卡券接口

https://mp.weixin.qq.com/merchant/cardapply?action=faq&t=cardticket/faq&lang=zh_CN&token=1772097641#2

缺少一个多客服获取聊天记录的API方法

文档如下
http://dkf.qq.com/document-1_1.html
以下是我写的代码，还么有具体测试。

def get_records(self, starttime, endtime, openid, pagesize=20, pageindex=1):
        """
        获取客服聊天记录接口
        详情请参考
        http://mp.weixin.qq.com/wiki/19/7c129ec71ddfa60923ea9334557e8b23.html

        :return: 返回的 JSON 数据包
        """
        data = NotNoneDict()
        data['starttime'] = starttime
        data['endtime'] = endtime
        data['openid'] = openid
        data['pagesize'] = pagesize
        data['pageindex'] = pageindex

        res = self._post('customservice/getrecord', data=data)
        return res.get('recordlist')

客服接口url错误

链接里多了/cgi-bin/
这是我打印的https://api.weixin.qq.com/cgi-bin/customservice/kfaccount/add
这是官方api里的:https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN

添加更新删除上传头像试过都报错

提交的commit能不能标注一下commit的类型

例如:
[FIX]表示 修复类
[IMP]表示 improve, 在原有功能上进行的优化和更新
[NEW]表示新增了功能

Add Changelog

ref issue #52

企业号被动响应消息中文消息收不到

微信开放平台

作者可以看看有没有可能转成新的方式

	原先方式	新方式(登录授权)
公众号是否需要提供appid和appsecret	需要	不需要
公众号是否需要配置服务器url和token	需要	不需要
可接入几个第三方开发服务	1个	5个(消息与菜单权限集只能授权给一家)

https://open.weixin.qq.com/cgi-bin/frame?t=home/wx_plugin_tmpl&lang=zh_CN
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&lang=zh_CN

消息加密解密

看了下好像没看到消息加密解密的代码:smile:
https://mp.weixin.qq.com/wiki/0/61c3a8b9d50ac74f18bdf2e54ddfc4e0.html

群发预览接口增加了对指定微信号发送预览

有空再加上呗

数据统计接口

• 用户分析数据接口
• 图文分析数据接口
• 消息分析数据接口
• 接口分析数据接口