快速上手

微信回调被动响应接入

验证请求有效性

假设你已经从微信服务器推送的请求参数中获取了 signature, timestamp, echostrnonce 参数,以及回调 token

from wechatpy.utils import check_signature
from wechatpy.exceptions import InvalidSignatureException

try:
    check_signature(token, signature, timestamp, nonce)
except InvalidSignatureException:
    # 处理异常情况或忽略

验证成功时,应原样返回 echostr 参数值。

解析 XML 消息

假设你已经从微信服务器推送的请求中获取了该 XML 消息正文并存储在变量 xml

对于明文模式,

from wechatpy import parse_message

msg = parse_message(xml)

对于加密模式,假设你的 token 变量名为 token ,AES key 变量名为 encoding_aes_key, App Id 变量名为 appid, 并且你已经从请求参数中提取了 msg_signature, timestamp, nonce 参数。将加密过的 XML 解密:

from wechatpy import parse_message
from wechatpy.crypto import WeChatCrypto
from wechatpy.exceptions import InvalidSignatureException, InvalidAppIdException

crypto = WeChatCrypto(token, encoding_aes_key, appid)
try:
    decrypted_xml = crypto.decrypt_message(
        xml,
        msg_signature,
        timestamp,
        nonce
    )
except (InvalidAppIdException, InvalidSignatureException):
    # 处理异常或忽略
    pass

msg = parse_message(decrypted_xml)

对于解析后的消息类型等信息请参考 推送消息推送事件 文档。

回复消息

假设被动响应收到的消息解析后保存在变量 msg

回复文本消息

from wechatpy.replies import TextReply

reply = TextReply(content='text reply', message=msg)
# 或者
reply = TextReply(message=msg)
reply.content = 'text reply'
# 转换成 XML
xml = reply.render()

快速回复文本消息:

from wechatpy.replies import create_reply

reply = create_reply('text reply', message=msg)
# 转换成 XML
xml = reply.render()

回复图片消息

from wechatpy.replies import ImageReply

reply = ImageReply(message=msg)
reply.media_id = 'image media id'
# 转换成 XML
xml = reply.render()

回复语音消息

from wechatpy.replies import VoiceReply

reply = VoiceReply(message=msg)
reply.media_id = 'voice media id'
# 转换成 XML
xml = reply.render()

回复视频消息

from wechatpy.replies import VideoReply

reply = VideoReply(message=msg)
reply.media_id = '必填,通过素材管理中的接口上传多媒体文件,得到的id'
reply.title = '选填,视频消息的标题'
reply.description = '选填,视频消息的描述'
# 转换成 XML
xml = reply.render()

回复音乐消息

from wechatpy.replies import MusicReply

reply = MusicReply(message=msg)
reply.thumb_media_id = '缩略图的媒体id'
reply.hq_music_url = '高质量音乐链接'
# 其他参数 music_url, title, description 等见文档
# 转换成 XML
xml = reply.render()

回复图文消息

from wechatpy.replies import ArticlesReply

reply = ArticlesReply(message=msg, articles=[
    {
        'title': '标题1',
        'description': '描述1',
        'url': 'http://www.qq.com',
    },
    {
        'title': '标题2',
        'description': '描述2',
        'url': 'http://www.qq.com',
        'image': 'http://img.qq.com/1.png',
    },
])
# 继续添加
reply.add_article({
    'title': '标题3',
    'description': '描述3',
    'url': 'http://www.qq.com',
})
# 转换成 XML
xml = reply.render()

更多回复类型请参考 回复 文档。

加密模式回复处理

对于加密模式,在将回复转换成 XML 后,还需要将其加密后返回给微信服务器。

假设你的 token 变量名为 token ,AES key 变量名为 encoding_aes_key, App Id 变量名为 appid, 并且你已经从请求参数中提取了 timestamp, nonce 参数。将 xml 加密:

from wechatpy.crypto import WeChatCrypto

crypto = WeChatCrypto(token, encoding_aes_key, appid)
encrypted_xml = crypto.encrypt_message(xml, nonce, timestamp)

基于 Flask Web 框架的简单的加密模式示例可参考 https://github.com/wechatpy/wechatpy/tree/master/examples/echo-encrypted

基于 Flask Web 框架的自适应加密和明文模式示例可参考 https://github.com/wechatpy/wechatpy/tree/master/examples/echo

微信主动调用接口使用

WeChatClient 基本使用方法:

from wechatpy import WeChatClient

client = WeChatClient('app_id', 'secret')
user = client.user.get('user id')
menu = client.menu.get()
client.message.send_text('user id', 'content')
# 以此类推
# client.media.xxx()
# client.group.xxx()

具体接口请参考 主动调用 API 文档 <client>

AccessToken

wechatpy 对于微信的 AccessToken 会在内部自动处理,一般单线程情况下情况下开发者不需要手动去操作,但是多线程情况下(如使用django, celery),务必使用持久化存储。如果开发者需要访问 AccessToken,可以通过 wechat_client.access_token 获取到。

wechatpy 支持多种 AccessToken 的持久化储存,下面以 Redis 作为示例

from wechatpy.client import WeChatClient
from wechatpy.session.redisstorage import RedisStorage
from redis import Redis

redis_client = Redis.from_url('redis://127.0.0.1:6379/0')
session_interface = RedisStorage(
    redis_client,
    prefix="wechatpy"
)

wechat_client = WeChatClient(
    app_id,
    secret,
    session=session_interface
)

对于 wechatpy 不支持的 Storage,也可以自定义 Storage,要使用 Storage,首先要实现自定义的 Storage,自定义的 Storage 需要实现 getsetdelete,具体示例如下

from wechatpy.session import SessionStorage

class CustomStorage(SessionStorage):

    def __init__(self, *args, **kwargs):
        pass

    def get(self, key, default=None):
        pass

    def set(self, key, value, ttl=None):
        pass

    def delete(self, key):
        pass

wechat_client = WeChatClient(
    app_id,
    secret,
    session=CustomStorage()
)