Docker-WeChatBot(微信机器人)

**相关链接：**
---
GitHub：https://github.com/danni-cool/wechatbot-webhook
Docker：https://hub.docker.com/r/dannicool/docker-wechatbot-webhook
部署指南：https://github.com/danni-cool/wechatbot-webhook#%EF%B8%8F-%E9%83%A8%E7%BD%B2-deploy%E6%8E%A8%E8%8D%90
推送指南：https://github.com/danni-cool/wechatbot-webhook?tab=readme-ov-file#1-%E6%8E%A8%E6%B6%88%E6%81%AF-api

## Docker run
```bash
docker run -d --name wxBotWebhook -p 3001:3001 -e LOGIN_API_TOKEN=ai773203918 dannicool/docker-wechatbot-webhook
```
额外参数(使用 -e 增加)：
- `RECVD_MSG_API`：当机器人收到消息时会将将消息推送到此接口上
- `DISABLE_AUTO_LOGIN`：服务重启时自动登录微信号
- `LOGIN_API_TOKEN`：自定义登录 API token

## docker-compose
```bash
nano docker-compose.yml
docker-compose up -d

nano .env  # 推荐独立配置文件,调试方便(修改配置文件重启服务即可,无需再次登录微信)
```
`docker-compose.yml`
```yaml
version: '3.8'
services:
  wxBotWebhook:
    image: dannicool/docker-wechatbot-webhook  # 镜像地址
    # container_name: wxbot_app  # 容器名称
    volumes:
      - ./log:/app/log  # 挂载日志文件夹
      - .env:/app/.env  # 使用配置文件来配置(方便调试)
    ports:
      - "3001:3001"  # 暴露端口
    # environment:  # 注意,使用环境变量的方式每次修改后都会重新部署,还需重登微信
      # - LOGIN_API_TOKEN=ai773203918 # 自定义Token
      # - LOG_LEVEL=info # 调整容器输出级别（不影响日志文件输出等级）运行时提示的消息等级（默认info，debug级别会输出详细的日志)
      # - DISABLE_AUTO_LOGIN=true # 关闭自动登录(自动登录最后一次账号)
      # - ACCEPT_RECVD_MSG_MYSELF=true # 如果希望机器人可以自己接收消息，填 true
      # - RECVD_MSG_API= # 如果想自己处理收到消息的逻辑，在下面填上你的API地址, 默认为空
    restart: always  # 容器非主动关闭会自动重启
```
`.env`
```bash
# 配置内容同 docker-compose.yml 中的环境变量,该文件的优先级低于环境变量
# 启动服务的端口
PORT=3001
# 运行时提示的消息等级（默认info，想有更详细的日志，可以指定为debug)
LOG_LEVEL=info
# 如果不希望登录一次后就记住当前账号，想每次都扫码登陆，填 true
DISABLE_AUTO_LOGIN=
# RECVD_MSG_API 是否接收来自自己发的消息
ACCEPT_RECVD_MSG_MYSELF=false
# 如果想自己处理收到消息的逻辑，在下面填上你的API地址, 默认为空
LOCAL_RECVD_MSG_API=http://127.0.0.1:555/webhook
# 登录地址Token访问地址： http://localhost:3001/login?token=[LOCAL_LOGIN_API_TOKEN]
LOCAL_LOGIN_API_TOKEN=ai773203918
```

## 使用方式
### 登录微信账号
- ⭐Web登录
```bash
http://[服务器]:[端口]/login?token=[LOCAL_LOGIN_API_TOKEN]  # 链接格式
	http://localhost:3001/login?token=ai773203918  # 示例
```
登录后再次访问，可以查看到账号就表示登录成功

- 通过日志中二维码登录
```bash
docker logs -f wxBotWebhook
```

### 消息发送
推送消息链接格式：`http://[服务器]:[端口]/webhook/msg/v2?token=[LOCAL_LOGIN_API_TOKEN]`
下列为实例测试，使用的是本地服务来测试，使用需自行修改，并且 `删除所有注释(# 和 // 开头)`
支持多对象推送，同对象多消息推送
```bash
curl --location --request POST 'http://localhost:3001/webhook/msg/v2?token=ai773203918' \  # 推送请求链接
--header 'Content-Type: application/json' \   # 请求头
--data-raw '[  // 多请求体,支持给多个对象推送消息(注意:结构不变,使用逗号隔开)
  {  // 请求体
    "to": "傲世之Jun",  // 接收者(对方微信名称/群聊名称,非微信号)
    // "isRoom": true,  // (可选)是否为群聊(true/false),若是不写则默认为false
    "data": [  // 消息数据列表,同一对象多条消息(注意:结构不变,使用逗号隔开)
      {  // 消息数据
        // "type": "text" ,  // (可选)消息类型(文本/URL text/fileUrl),若是不写则默认为文本
        "content": "你好👋"  // 消息内容(URL可拼接 {要发送的URL链接}?$alias={文件别名})
      },
      {  // 消息数据
        "type": "fileUrl" ,  // (可选)消息类型(文本/URL text/fileUrl),若是不写则默认为文本
        "content": "https://nas.918178.xyz:10086/static/search/mrdoc_logo_300.png?$alias=zwzw.png"  // 消息内容(URL可拼接 {要发送的URL链接}?$alias={文件别名})
      },
    ]
  },
  {  // 请求体
    "to": "Sherry",  // 接收者(对方微信名称/群聊名称,非微信号)
    // "isRoom": true,  // (可选)是否为群聊(true/false),若是不写则默认为false
    "data": [  // 消息数据列表,同一对象多条消息(注意:结构不变,使用逗号隔开)
      {  // 消息数据
        // "type": "text" ,  // (可选)消息类型(文本/URL text/fileUrl),若是不写则默认为文本
        "content": "你好👋"  // 消息内容(URL可拼接 {要发送的URL链接}?$alias={文件别名})
      },
      {  // 消息数据
        "type": "fileUrl" ,  // (可选)消息类型(文本/URL text/fileUrl),若是不写则默认为文本
        "content": "https://nas.918178.xyz:10086/media/202205/2022-05-15_175441_184923.png"  // 消息内容(URL可拼接 {要发送的URL链接}?$alias={文件别名})
      },
    ]
  },
]'
```
`推送反馈的回执`
```json
{
  "success": true,  // 消息发送成功与否
  "message": "Message sent successfully",  // 消息提示(消息已成功发送)
  "task": {
    "successCount": 1,  // 发送成功条数
    "totalCount": 1,  // 总消息条数
    "failedCount": 0,  // 发送失败条数
    "reject": [],  // 拒绝的消息
    "sentFailed": [],  // 发送失败的消息
    "notFound": []  // 因为未找到用户或者群和 error 提示
  }
}
```

### 消息接收
需要配置 `RECVD_MSG_API` 环境变量才可，当机器人收到消息时会将消息主体以 `POST` 形式推送到该接口上
```json
{
  "type": "text",  // 消息类型
  "content": "你好",  // 消息内容
  "source": "{}",  // 消息发送方的数据
  "isMentioned": "0",  // 是否被艾特
  "isMsgFromSelf": "0",  // 是否自己发送给自己的消息
  "isSystemEvent": "0"  // 被遗弃的参数
}
```

收消息后立即回复(快捷回复)，按以下结构返回返回值，无返回值则不会回复消息(就是请求后返回的内容)
```json
{
  "success": true,  // 成功
  "data": [  // 支持回复多条消息
    {
      "type": "text",  // 消息类型
      "content": "你好👋"  // 消息内容1
    },
    {
      "type": "text",  // 消息类型
      "content": "hello world!"  // 消息内容2
    }
  ]
}
```

## 实例
定时通知+通知确认(回复指定内容才会停止)
```bash
# 9/20 定时通知
0 9,20 * * * python send_message.py
```
```python
# pip install Flask requests
from flask import Flask, request, jsonify  # 用于处理请求
import json  # json处理
import time  # 时间
import requests  # 发起请求
import threading  # 后台运行main
import os  # 用于停止当前程序

# 定义发送消息的函数(接受者,内容)
def send_message(to,content):
    headers = {'Content-Type': 'application/json'}
    data = [{
        "to": f"{to}",
        "data": [{
            "content": f"{content}"
        },]
    }]
    # print(data)  # 打印发送的消息内容(测试使用)
    try:
        response = requests.post(
            'http://127.0.0.1:3001/webhook/msg/v2?token=ai773203918',
            headers=headers,
            json=data
        )
        # 检查响应状态码
        if response.status_code == 200:
            print("消息推送成功")
        else:
            print(f"消息推送失败，状态码：{response.status_code}")
    except requests.RequestException as e:
        # 打印请求过程中发生的异常
        print(f"推送请求过程中发生错误：{e}")
    return response
# 定义主函数
def main():
    while True:
        send_message("傲世之Jun","你好\n回复'1'停止通知")
        time.sleep(120)  # 每x秒发送一次

# 创建Flask应用
app = Flask(__name__)
# 处理POST请求,请求的URL是/webhook
@app.route('/webhook', methods=['POST'])
def receive_message():
    # 确保请求是multipart/form-data类型(wechatbot-webhook 请求的类型)
    if 'multipart/form-data' in request.headers['Content-Type']:
        data = request.form.to_dict()  # 获取文件和表单数据
        # print(json.dumps(data, ensure_ascii=False, indent=4))  # 打印接收到的数据(测试使用)

# 这里可以根据formData的type字段来处理不同类型的数据
        text_content = data.get('content')  # 获取 content 内容(接收到的消息内容)
        # print(f"消息内容: {text_content}")  # 打印消息内容(测试使用)

# 获取发送者/接受者信息
        text_source = data.get('source')  # 获取 source 内容(发送和接收者的信息在这里)
        source_data = json.loads(text_source)  # 转换为JSON格式(原 multipart/form-data 格式)
        to_name = source_data.get('to', {}).get('payload', {}).get('name', 'Unknown')  # 获取接收者
        from_name = source_data.get('from', {}).get('payload', {}).get('name', 'Unknown')  # 获取发送者
        # print(f"接收者: {to_name},发送者: {from_name}")  # 打印接受者和发送者(测试使用)

print(f"发送者: {from_name},接收者: {to_name},消息内容: {text_content}")  # 打印接收的消息(测试使用)
        # 检查是否是特定发送者和内容的消息(用于停止通知)
        if from_name == '傲世之Jun' and text_content == '1':
            print("接收到了特定发送者的消息,停止程序...")
            send_message("傲世之Jun","停止该阶段通知...")  # 发送有效停止指令通知
            os._exit(0)  # 停止程序
    else:
        # 如果不是multipart/form-data类型，返回错误
        return jsonify({"status": "error", "message": "无效的内容类型"}), 400

if __name__ == '__main__':
    # 首先运行main函数，然后再启动Flask服务
    thread = threading.Thread(target=main)
    thread.start()
    app.run(host='0.0.0.0', port=3002)  # 运行Flask服务
```

**相关教程：**
[你们要的微信机器人相关的教程来啦](https://mp.weixin.qq.com/s/li89EQ-q-r6kbxUqJXex-w)