wxBot

wxBot 是用Python包装Web微信协议实现的微信机器人框架。

目前的消息支持情况:

• [ ] 群消息

  • [x] 文本
  • [x] 图片
  • [x] 地理位置
  • [x] 个人名片
  • [x] 语音
  • [x] 动画
  • [ ] 语音电话
  • [ ] 红包

• [ ] 联系人消息

  • [x] 文本
  • [x] 图片
  • [x] 地理位置
  • [x] 个人名片
  • [x] 语音
  • [x] 小视频
  • [x] 动画
  • [ ] 视频电话
  • [ ] 红包
  • [ ] 转账

• [x] 消息发送

  • [x] 文本
  • [x] 图片
  • [x] 文件

Web微信协议参考资料：

挖掘微信Web版通信的全过程

微信协议简单调研笔记

qwx: WeChat Qt frontend 微信Qt前端

master-dev 分支为开发版本，用于测试新特性，欢迎使用后提出建议!

1 环境与依赖

此版本只能运行于Python 2环境 。

wxBot 用到了Python requests , pypng , Pillow 以及 pyqrcode 库。

使用之前需要所依赖的库:

pip install requests
pip install pyqrcode
pip install pypng
pip install Pillow

2 快速开发

利用 wxBot 最简单的方法就是继承WXBot类并实现

handle_msg_all

schedule

run

2.1 代码

以下的代码对所有来自好友的文本消息回复文本消息 hi 、图片消息 1.png 以及文件消息 1.png ， 并不断向好友 tb 发送文本 schedule 。

handle_msg_all

schedule

#!/usr/bin/env python
# coding: utf-8

import time
from wxbot import *
class MyWXBot(WXBot):
    def handle_msg_all(self, msg):
        if msg['msg_type_id'] == 4 and msg['content']['type'] == 0:
            self.send_msg_by_uid(u'hi', msg['user']['id'])
            self.send_img_msg_by_uid("img/1.png", msg['user']['id'])
            self.send_file_msg_by_uid("img/1.png", msg['user']['id'])
def schedule(self):
    self.send_msg(u'tb', u'schedule')
    time.sleep(1)
def main():
    bot = MyWXBot()
    bot.DEBUG = True
    bot.run()
if name == 'main':
    main()

2.2 运行

直接用

python

python test.py

2.3 登录微信

程序运行之后，会在当前目录下生成二维码图片文件 qr.png 并自动打开，用微信扫描此二维码并按操作指示确认登录网页微信。

如果运行在Linux下，还可以通过设置 WXBot 对象的

conf['qr']

tty

3 效果展示

测试代码 test.py 的运行效果：

4 接口

4.1

handle_msg_all

handle_msg_all

msg

| 字段名 | 字段内容 | | ----- | --- | |

msg_type_id

msg_id

content

type

data

type

data

user

name

id

4.2 消息类型表

| 类型号 | 消息类型 |

content

type

data

user

id

name

type

data

type

type

data

type

data

type

data

4.3 数据类型表

|

type

data

nickname

alias

province

city

gender

type

title

desc

url

from

4.4 群文本消息

由于群文本消息中可能含有@信息，因此群文本消息的

content

type

data

detail

desc

各字段内容为：

| 字段 | 内容 | | --- | ---- | |

type

data

desc

detail

type

value

type

4.5 WXBot对象属性

WXBot 对象在登录并初始化之后,含有以下的可用数据:

| 属性 | 描述 | | ---- | ---- | |

contact_list

group_list

public_list

special_list

session

Session

4.6 WXBot对象方法

WXBot 对象还含有一些可以利用的方法

| 方法 | 描述 | | ---- | --- | |

get_icon(uid, gid)

uid

gid

get_head_img(id)

id

get_msg_img(msgid)

msgid

get_voice(msgid)

msgid

get_video(msgid)

msgid

get_contact_name(uid)

remark_name

nickname

display_name

send_msg_by_uid(word, dst)

word

dst

send_img_msg_by_uid(fpath, dst)

fpath

dst

send_file_msg_by_uid(fpath, dst)

fpath

dst

send_msg_by_uid(word, dst)

word

dst

send_msg(name, word, isfile)

name

isfile

False

word

isfile

True

word

send_msg_by_uid(word, dst)

is_contact(uid)

uid

True

False

is_public(uid)

uid

True

False

5 群聊机器人示例

bot.py 用 图灵机器人 API 以及 wxBot 实现了一个自动回复机器人.

此机器人会回复来自联系人的消息，以及群里@此账号的消息。

并且本帐号可以通过发送 退下 、 走开 、 关闭 、 关掉 、 休息 、 滚开 来关闭机器人的自动回复。

也可以通过发送 出来 、 启动 、 工作 来再次开启机器人的自动回复。

群聊时需要将对应的群保存到联系人列表。

群聊实现效果：

bot.py 的运行方法：

• 要接入图灵机器人API时：

1. 在图灵机器人官网注册账号，申请图灵key: 图灵key申请地址

2. 在 bot.py 文件所在目录下新建 conf.ini 文件，内容为:(key字段内容为申请到的图灵key)

   [main]    
   key=1d2678900f734aa0a23734ace8aec5b1
   

3. 运行 bot.py

   python bot.py
   

• 不接入图灵机器人API时(此时机器人对联系人消息以及群里@自己的消息统一回复 知道了 )：

  1. 运行 bot.py

  python bot.py
  

6 类似项目

feit/Weixinbot Nodejs 封装网页版微信的接口，可编程控制微信消息

littlecodersh/ItChat 微信个人号接口、微信机器人及命令行微信，Command line talks through Wechat

Urinx/WeixinBot 网页版微信API，包含终端版微信及微信机器人

zixia/wechaty Wechaty is wechat for bot in Javascript(ES6). It's a Personal Account Robot Framework/Library.

7 基于Wxbot延伸的一些项目

WxbotManage 基于Wxbot的微信多开管理和Webapi系统

8 交流讨论

问题可以直接开 issue

QQ 交流群： 429134510 (1群) 603614392 (2群)