diff --git a/.gitignore b/.gitignore index 7dea058..0a652e3 100644 --- a/.gitignore +++ b/.gitignore @@ -94,4 +94,8 @@ ENV/ .idea *.pyc -saved/qrcodes/qrcode.jpg \ No newline at end of file +wxbot_demo_py3/saved/ +wxbot_project_py2.7/tmp_data/ +wxbot_project_py2.7/wechat/wechat_js_backup/ +wxbot_project_py2.7/config/wechat.conf +wxbot_project_py2.7/wiki/ diff --git a/README.md b/README.md index c5b7c82..d62c138 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,42 @@ -# WeixinBot [](http://github.com/Urinx/WeixinBot) [](http://github.com/Urinx/WeixinBot/fork)  +# WeixinBot [](http://github.com/Urinx/WeixinBot) [](http://github.com/Urinx/WeixinBot/fork)  网页版微信API,包含终端版微信及微信机器人 -## Demo -为了运行 `weixin.py` 示例脚本,你需要有安装 `qrcode` 包,你可以通过 `pip install qrcode` 来安装。 +## Contents +* [Demo](#Demo) +* [Web Weixin Pipeline](#Web-Weixin-Pipeline) +* [Web Weixin API](#Web-Weixin-API) +* [Discussion Group](#Discussion-Group) +* [Recent Update](#Recent-Update) - +## Demo +为了确保能正常运行示例脚本,请安装所需的第三方包。 + +``` +pip install -r requirements.txt +``` + +注:下面演示的图片与功能可能不是最新的,具体请看源码。 + +
+
-
+
+
+ #####################
+ # WeChat Bot Server #
+ #####################
+
+
+## APIs
+
+- /qrcode
+ ------------------------
+ @brief login qrcode
+ @method get
+ @return raw image
+ ------------------------
+
+- /runtime
+ -----------------------------
+ @brief basic info
+ @method get
+ @return application/json
+ {
+ 'ret': 0,
+ 'runtime': '',
+ 'total_size': '',
+ 'db_size': '',
+ 'msg_count': '',
+ 'image_count': '',
+ 'voice_count': '',
+ 'video_count': '',
+ }
+ -----------------------------
+
+- /group_list
+ ------------------------
+ @brief list groups
+ @method get
+ ------------------------
+
+- /group_member_list/<g_id>
+ -----------------------------
+ @brief list group member
+ @method get
+ @param g_id String
+ -----------------------------
+
+- /group_chat_log/<g_name>
+ -------------------------------
+ @brief list group chat log
+ @method get
+ @param g_name String
+ -------------------------------
+
+- /upload
+ -------------------------------
+ @brief upload a file
+ @method get/post
+ @return application/json
+ {
+ 'ret': 0,
+ 'msg': '',
+ }
+ -------------------------------
+
+- /send_msg/<to>/<msg>
+ -------------------------------------------
+ @brief send message to user or gourp
+ @method get
+ @param to: String, user id or group id
+ @param msg: String, words
+ @return application/json
+ {
+ 'ret': 0,
+ }
+ -------------------------------------------
+
+- /send_img/<to>/<img>
+ -------------------------------------------
+ @brief send image to user or gourp
+ @method get
+ @param to: String, user id or group id
+ @param img: String, image file name
+ @return application/json
+ {
+ 'ret': 0,
+ }
+ -------------------------------------------
+
+- /send_emot/<to>/<emot>
+ -------------------------------------------
+ @brief send emotion to user or gourp
+ @method get
+ @param to: String, user id or group id
+ @param emot: String, emotion file name
+ @return application/json
+ {
+ 'ret': 0,
+ }
+ -------------------------------------------
+
+- /send_file/<to>/<file>
+ -------------------------------------------
+ @brief send emotion to user or gourp
+ @method get
+ @param to: String, user id or group id
+ @param file: String, file name
+ @return application/json
+ {
+ 'ret': 0,
+ }
+ -------------------------------------------
+
+- /mass_send_msg
+ -------------------------------------------
+ @brief send text to mass users or gourps
+ @method post
+ @param application/json
+ {
+ 'to_list': [
+ 'group_id',
+ ...
+ ],
+ 'msg': '',
+ }
+ @return application/json
+ {
+ 'ret': 0,
+ 'unsend_list': [],
+ }
+ -------------------------------------------
+
+- /mass_send_img
+ -------------------------------------------
+ @brief send image to mass users or gourps
+ @method post
+ @param application/json
+ {
+ 'to_list': [
+ 'group_id',
+ ...
+ ],
+ 'msg': '',
+ }
+ @return application/json
+ {
+ 'ret': 0,
+ 'unsend_list': [],
+ }
+ -------------------------------------------
+
+- /mass_send_emot
+ -------------------------------------------
+ @brief send emoticon to mass users or gourps
+ @method post
+ @param application/json
+ {
+ 'to_list': [
+ 'group_id',
+ ...
+ ],
+ 'msg': '',
+ }
+ @return application/json
+ {
+ 'ret': 0,
+ 'unsend_list': [],
+ }
+ -------------------------------------------
+
+- /mass_send_file
+ -------------------------------------------
+ @brief send file to mass users or gourps
+ @method post
+ @param application/json
+ {
+ 'to_list': [
+ 'group_id',
+ ...
+ ],
+ 'msg': '',
+ }
+ @return application/json
+ {
+ 'ret': 0,
+ 'unsend_list': [],
+ }
+ -------------------------------------------
+
+