Example and document.

README.md

@@ -2,8 +2,10 @@
 
 Python包装WEB微信实现的微信机器人框架。可以很容易地实现微信机器人。
 
-## 依赖
-程序用到了Python requests 和 pyqrcode库，使用之前需要安装这两个库:
+## 环境与依赖
+
+目前只能运行于Windows下的Python 2环境 。
+wxBot用到了Python requests 和 pyqrcode库，使用之前需要安装这两个库:
 
 ```bash
 pip install requests
@@ -36,10 +38,10 @@ if __name__ == '__main__':
 
 ### 运行
 
-直接用python运行代码(如运行测试代码main.py):
+直接用python运行代码(如运行测试代码test.py):
 
 ``` python
-python main.py
+python test.py
 ```
 
 ### 登录微信
@@ -50,8 +52,52 @@ python main.py
 ![1](img/1.png)
 
 ## 效果展示
-测试代码main.py的运行效果：
+
+测试代码test.py的运行效果：
 
 ![向机器人发送消息](img/send_msg.png)
 
 ![后台](img/backfront.jpg)
+
+## 接口
+### handle_msg_all
+
+handle_msg_all函数的参数msg是代表一条消息的字典。一般包含以下字段：
+
+| 字段名 | 意义 |
+| ----- | --- |
+| msg_id | 消息id，微信内部数据 |
+| msg_type_id | 消息类型，具体见消息类型表 |
+| user_id | 发送消息的用户的id，微信内部数据 |
+| user_name | 发送消息的用户的名字，为备注名或者微信用户名 |
+| content | 消息体，不同类型消息的此字段内容不同，具体见消息类型表 |
+
+消息类型表：
+
+| 类型号 | 类型名称 | 类型描述 | content |
+| ------ | ------- | --- | -------- |
+| 1 | Location | 位置 | 字典,包含location(位置的文本描述)和xml(原始未解析的xml格式文本)字段 |
+| 2 | FileHelper | 文件 | 字符串,文本文件内容 |
+| 3 | Self | 自己发送的消息 | 字符串，文本消息 |
+| 4 | Group | 群消息 | 字典，包含group_id(微信内部id), group_name(群名), user(微信内部id), user_name(用户名称), msg(字符串消息)字段 |
+| 5 | Text | 普通文本消息 | 字符串， 文本消息 |
+| 6 | Image | 图片 | 字符串， 图片url |
+| 7 | Voice | 语音 | 字符串， 语音url |
+| 8 | Recommend | 微信名片 | 字典， 包含nickname(昵称)，alias(别名)，province(省份)，city(城市)， gender(性别)字段 |
+| 9 | Animation | 动画 | 字符串， 动画url |
+| 10 | Share | 分享 | 字典，包含type(类型)，title(标题)，desc(描述)，url(链接)，from(来自)字段 |
+| 11 | Video | 视频 | 字符串，未解析的xml字符串 |
+| 12 | VideoCall | 视频电话 | 字符串，未解析的xml字符串 |
+| 13 | Redraw | 撤回消息 | 字符串，未解析的xml字符串 |
+| 14 | Init | 微信初始化系统消息，可以忽略 | 字符串，未解析的xml字符串 |
+| 99 | Unknown | 未知类型 | 字符串，未解析的xml字符串 |
+
+### WXBot对象属性
+
+WXBot对象在登录并初始化之后,含有以下的可用数据:
+
+| 属性 | 描述 |
+| ---- | ---- |
+| contact_list | 当前用户的微信联系人列表 |
+| group_list | 当前用户的微信群列表 |
+| session | WXBot与WEB微信服务器端交互所用的requests Session对象 |

wxbot.py

@@ -31,7 +31,7 @@ class WXBot:
         self.sid = ''
         self.skey = ''
         self.pass_ticket = ''
-        self.deviceId = 'e' + repr(random.random())[2:17]
+        self.device_id = 'e' + repr(random.random())[2:17]
         self.base_request = {}
         self.sync_key_str = ''
         self.sync_key = []
@@ -118,7 +118,7 @@ class WXBot:
             'Uin': self.uin,
             'Sid': self.sid,
             'Skey': self.skey,
-            'DeviceID': self.deviceId,
+            'DeviceID': self.device_id,
             }
         return True
 
@@ -208,7 +208,7 @@ class WXBot:
             'sid': self.sid,
             'uin': self.uin,
             'skey': self.skey,
-            'deviceid': self.deviceId,
+            'deviceid': self.device_id,
             'synckey': self.sync_key_str,
             '_': int(time.time()),
         }
@@ -359,7 +359,7 @@ class WXBot:
                     group = self.get_user_remark_name(msg['FromUserName'])
                     name = self.get_user_remark_name(people)
                     msg_type_id = 4
-                    content = {'group_id': msg['FromUserName'], 'group_name': group, 'user': people, 'user_name': name}
+                    content = {'group_id': msg['FromUserName'], 'group_name': group, 'user': people, 'user_name': name, 'msg': content}
                     if self.DEBUG:
                         print '[Group] |%s| %s: %s' % (group, name, content.replace('<br/>','\n'))