{"id":13487809,"url":"https://github.com/wangrongding/wechat-bot","last_synced_at":"2025-05-12T13:26:08.302Z","repository":{"id":64366939,"uuid":"438514144","full_name":"wangrongding/wechat-bot","owner":"wangrongding","description":"🤖一个基于 WeChaty 结合 DeepSeek / ChatGPT / Kimi / 讯飞等Ai服务实现的微信机器人 ，可以用来帮助你自动回复微信消息，或者管理微信群/好友，检测僵尸粉等...","archived":false,"fork":false,"pushed_at":"2025-03-26T09:31:56.000Z","size":1112,"stargazers_count":8191,"open_issues_count":103,"forks_count":1003,"subscribers_count":48,"default_branch":"main","last_synced_at":"2025-04-23T07:06:46.941Z","etag":null,"topics":["chatgpt","openai","wechat","wechatbot","wechaty"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wangrongding.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-15T06:04:18.000Z","updated_at":"2025-04-23T06:19:24.000Z","dependencies_parsed_at":"2024-01-12T23:42:09.554Z","dependency_job_id":"51a278b6-424a-4bc8-86d3-def8bdacf925","html_url":"https://github.com/wangrongding/wechat-bot","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangrongding%2Fwechat-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangrongding%2Fwechat-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangrongding%2Fwechat-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangrongding%2Fwechat-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wangrongding","download_url":"https://codeload.github.com/wangrongding/wechat-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253746588,"owners_count":21957593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","openai","wechat","wechatbot","wechaty"],"created_at":"2024-07-31T18:01:04.299Z","updated_at":"2025-05-12T13:26:08.270Z","avatar_url":"https://github.com/wangrongding.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Resources","Integrations","A01_文本生成_文本对话","WeChat","Repos","Chatbots"],"sub_categories":["Integration with Wechat","WeChat","大语言对话模型及数据"],"readme":"# WeChat Bot\n\n### Tip：最近本人正在看新的工作机会，如果你有合适的 `前端开发岗位` 在招，欢迎一起聊聊，我的 wx: ChicSparrow\n\n一个 基于 `chatgpt` + `wechaty` 的微信机器人\n\n可以用来帮助你自动回复微信消息，或者管理微信群/好友.\n\n`简单`，`好用`，`2分钟（4 个步骤）` 就能玩起来了。🌸 如果对您有所帮助，请点个 Star ⭐️ 支持一下。\n\n\u003cdiv align='center'\u003e\n  \u003ca href=\"https://trendshift.io/repositories/11077\" target=\"_blank\"\u003e\u003cimg src=\"https://trendshift.io/api/badge/repositories/11077\" alt=\"wangrongding%2Fwechat-bot | Trendshift\" style=\"width: 250px; height: 55px;\" width=\"250\" height=\"55\"/\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## 贡献者们\n\n\u003ca href=\"https://github.com/wangrongding/wechat-bot/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=wangrongding/wechat-bot\u0026columns=20\" /\u003e\n\u003c/a\u003e\n\n欢迎大家提交 PR 接入更多的 ai 服务(比如扣子等...)，积极贡献更好的功能实现，让 wechat-bot 变得更强！\n\n## 注意：最近微信对此审查变得非常严格，使用默认的协议有微信警告或者封号的风险，请大家谨慎使用，关于 padlocal 这个协议，由于作者被腾讯告了，所以没有继续维护，我们最近正在重构底层实现，或切换更好的协议（目前我本地已跑通，大家可以稍加等候）。\n\n## 使用前需要配置的 AI 服务（目前支持 9 种，可任选其一）\n\n- deepseek\n\n  获取自己的 `api key`，地址戳这里 👉🏻 ：[deepseek 开放平台](https://platform.deepseek.com/usage)  \n  将获取到的`api key`填入 `.evn` 文件中的 `DEEPSEEK_FREE_TOKEN` 中。\n\n- ChatGPT\n\n  先获取自己的 `api key`，地址戳这里 👉🏻 ：[创建你的 api key](https://platform.openai.com/settings/organization/api-keys)\n\n  **注意：这个是需要去付费购买的，很多人过来问为什么请求不通，请确保终端走了代理，并且付费购买了它的服务**\n\n  ```sh\n  # 执行下面命令，拷贝一份 .env.example 文件为 .env\n  cp .env.example .env\n  # 填写完善 .env 文件中的内容\n  OPENAI_API_KEY='你的key'\n  ```\n\n- 通义千问\n\n  通义千问是阿里云提供的 AI 服务，获取到你的 api key 之后, 填写到 .env 文件中即可\n\n  ```sh\n  # 执行下面命令，拷贝一份 .env.example 文件为 .env\n  cp .env.example .env\n  # 填写完善 .env 文件中的内容\n  # 通义千问, URL 包含 uri 路径\n  TONGYI_URL = \"https://dashscope.aliyuncs.com/compatible-mode/v1\"\n  # 通义千问的 API_KEY\n  TONGYI_API_KEY = ''\n  # 通义千问使用的模型\n  TONGYI_MODEL='qwen-plus'\n  ```\n\n- 科大讯飞\n\n  新增科大讯飞，去这里申请一个 key：[科大讯飞](https://console.xfyun.cn/services/bm35)，每个模型都有 200 万的免费 token ，感觉很难用完。  \n  注意： 讯飞的配置文件几个 key，别填反了，很多人找到我说为什么不回复，都是填反了。  \n  而且还有一个好处就是，接口不会像 Kimi 一样限制请求频次，相对来说稳定很多。  \n  服务出错可参考： [issues/170](https://github.com/wangrongding/wechat-bot/issues/170), [issues/180](https://github.com/wangrongding/wechat-bot/issues/180)\n\n- Kimi （请求限制较严重）\n\n  可以去 ： [kimi apikey](https://platform.moonshot.cn/console/api-keys) 获取你的 key  \n  最近比较忙，大家感兴趣可以提交 PR，我会尽快合并。目前 Kimi 刚刚集成，还可以实现上传文件等功能，然后有其它较好的服务也可以提交 PR 。\n\n- dify\n\n  地址：[dify](https://dify.ai/), 创建你的应用之后, 获取到你的 api key 之后, 填写到 .env 文件中即可, 也支持私有化部署dify版本\n\n  ```sh\n  # 执行下面命令，拷贝一份 .env.example 文件为 .env\n  cp .env.example .env\n  # 填写完善 .env 文件中的内容\n  DIFY_API_KEY='你的key'\n  # 如果需要私有化部署，请修改.env中下面的配置\n  # DIFY_URL='https://[你的私有化部署地址]'\n  ```\n\n- ollama\n\n  Ollama 是一个本地化的 AI 服务，它的 API 与 OpenAI 非常接近。配置 Ollama 的过程与各种在线服务略有不同\n\n  ```sh\n  # 执行下面命令，拷贝一份 .env.example 文件为 .env\n  cp .env.example .env\n  # 填写完善 .env 文件中的内容\n  OLLAMA_URL='http://127.0.0.1:11434/api/chat'\n  OLLAMA_MODEL='qwen2.5:7b'\n  OLLAMA_SYSTEM_MESSAGE='You are a personal assistant.'\n  ```\n\n- 302.AI\n\n  AI聚合平台，有套壳GPT的API，也有其他模型，点这里可以[添加API](https://dash.302.ai/apis/list)，添加之后把API KEY配置到.env里，如下，MODEL可以自行选择配置\n\n  ```\n  _302AI_API_KEY = 'xxxx'\n  _302AI_MODEL= 'gpt-4o-mini'\n  ```\n\n  由于openai充值需要国外信用卡，流程比较繁琐，大多需要搞国外虚拟卡，手续费也都不少，该平台可以直接支付宝，算是比较省事的，注册填问卷可领1刀额度，后续充值也有手续费，用户可自行酌情选择。\n\n- claude\n\n  前往 [官网](https://console.anthropic.com) 注册并获取API KEY后进行配置即可\n\n  ```bash\n  # 执行下面命令，拷贝一份 .env.example 文件为 .env，如果已存在则忽略此步\n  cp .env.example .env\n\n  # 编辑.env文件并添加claude相关配置\n\n  CLAUDE_API_VERSION = '2023-06-01'\n  CLAUDE_API_KEY = '你的API KEY'\n  CLAUDE_MODEL = 'claude-3-5-sonnet-latest'\n  # 系统人设\n  CLAUDE_SYSTEM = ''\n  ```\n\n- 其他  \n  （待实践）理论上使用 openAI 格式的 api，都可以使用，在 env 文件中修改对应的 api_key、model、proxy_url 即可。\n\n## API资源/平台收录\n\n- [gpt4free](https://github.com/xtekky/gpt4free)\n- [chatanywhere](https://github.com/chatanywhere/GPT_API_free)\n\n## 赞助商\n\n\u003cdiv align=\"center\"\u003e\n  \u003ctable\u003e\n    \u003c!-- Header --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" width=\"100%\"\u003e\n        \u003cp align=\"center\"\u003e\n          \u003ca href=\"https://gpt302.saaslink.net/hqRIfk\" target=\"_blank\"\u003e\n            \u003cimg src=\"./sponsors/302AI.png\" alt=\"Hi\" width=\"300px\"/\u003e\n          \u003c/a\u003e\n        \u003c/p\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003c!-- des --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\"\u003e\n        302.AI是一个按需付费的一站式企业级AI应用平台，开放平台，开源生态，让AI为每个需求找到答案。\n        \u003ca href=\"https://gpt302.saaslink.net/hqRIfk\" target=\"_blank\"\u003e产品链接\u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\u003c/div\u003e\n\n目前该项目流量较大，已经上过 27 次 [Github Trending 榜](https://github.com/trending)，如果您的公司或者产品需要推广，可以在下方二维码处联系我，我会在项目中加入您的广告，帮助您的产品获得更多的曝光。\n\n## 开发/使用\n\n检查好自己的开发环境，确保已经安装了 `nodejs` , 版本需要满足 Node.js \u003e= v18.0 ，版本太低会导致运行报错,最好使用 LTS 版本。\n\n1. 安装依赖\n\n\u003e 安装依赖时，大陆的朋友推荐切到 taobao 镜像源后再安装，命令：  \n\u003e `npm config set registry https://registry.npmmirror.com`  \n\u003e 想要灵活切换，推荐使用我的工具 👉🏻 [prm-cli](https://github.com/wangrongding/prm-cli) 快速切换。\n\n```sh\n# 安装依赖\nnpm i\n# 推荐用 yarn 吧，npm 安装有时会遇到 wechaty 内部依赖安装失败的问题\nyarn\n```\n\n2. 运行服务\n\n```sh\n# 启动服务\nnpm run dev # 或者 npm run start\n# 启动服务\nyarn dev # 或者 yarn start\n```\n\n然后就可以扫码登录了，然后根据你的需求，自己修改相关逻辑文件。\n\n![](https://assets.fedtop.com/picbed/202403261420468.png)\n\n![](https://assets.fedtop.com/picbed/202212071315670.png)\n\n为了兼容 docker 部署，避免不必要的选择交互，新增指定服务运行\n\n```sh\n# 运行指定服务 （ 目前支持 ChatGPT | Kimi | Xunfei ）\nnpm run start -- --serve Kimi\n# 交互选择服务，仍然保持原有的逻辑\nnpm run start\n```\n\n3. 测试\n\n安装完依赖后，运行 `npm run dev` 前，可以先测试下 openai 的接口是否可用，运行 `npm run test` 即可。\n\n遇到 timeout 问题需要自行用魔法解决。（一般就是代理未成功，或者你的魔法服务限制了 openai api 的服务）\n\n## 你要修改的\n\n很多人说运行后不会自动收发信息，不是的哈，为了防止给每一条收到的消息都自动回复（太恐怖了），所以加了限制条件。\n\n你要把下面提到的地方自定义修改下。\n\n- 群聊，记得把机器人名称改成你自己微信号的名称，然后添加对应群聊的名称到白名单中，这样就可以自动回复群聊消息了。\n- 私聊，记得把需要自动回复的好友名称添加到白名单中，这样就可以自动回复私聊消息了。\n- 更深入的可以通过修改 `src/wechaty/sendMessage.js` 文件来满足你自己的业务场景。（大多人反馈可能无法自动回复，也可以通过调试这个文件来排查具体原因）\n\n在.env 文件中修改你的配置即可，示例如下\n\n```sh\n# 白名单配置\n#定义机器人的名称，这里是为了防止群聊消息太多，所以只有艾特机器人才会回复，\n#这里不要把@去掉，在@后面加上你启动机器人账号的微信名称\nBOT_NAME=@可乐\n#联系人白名单\nALIAS_WHITELIST=微信名1,备注名2\n#群聊白名单\nROOM_WHITELIST=XX群1,群2\n#自动回复前缀匹配，文本消息匹配到指定前缀时，才会触发自动回复，不配或配空串情况下该配置不生效（适用于用大号，不期望每次被@或者私聊时都触发自动回复的人群）\n#匹配规则：群聊消息去掉${BOT_NAME}并trim后进行前缀匹配，私聊消息trim后直接进行前缀匹配\nAUTO_REPLY_PREFIX=''\n```\n\n可以看到，自动回复都是基于 `chatgpt` 的，记得要开代理，或者填写代理地址。\n\n![](https://github.com/user-attachments/assets/1c312cf4-73d8-44a1-8f36-5ea288ac0aa4)\n\n## 注意项\n\n近期微信审查很严格，大量用户反映弹出外挂警告，由于项目内默认使用的是免费版的 web 协议，所以目前来说很容易会被微信检测到，建议使用 pad 协议，或者自行购买企业版协议，避免被封号。\n\n修改可参考： https://github.com/wangrongding/wechat-bot/pull/263/files  \n自行购买 pad 协议渠道（wechaty 出的，购买仍需谨慎）：http://pad-local.com  \n由于底层依赖的 wechaty 本身不怎么维护了，听说是被腾讯告了，所以大家购买也要谨慎，群友分享目前 pad 协议可正常使用(但频繁登录登出也会收到警告)，最好别一次性买太久的。\n\n## 常见问题\n\n可以进交流群,一起交流探讨相关问题和解决方案，添加的时候记得备注来意。（如果项目对你有所帮助，也可以请我喝杯咖啡 ☕️ ~）\n\n| \u003cimg src=\"https://github.com/user-attachments/assets/902b1a20-0ea0-4348-9ac1-b9eb6645223c\" width=\"180px\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/wangrongding/image-house/master/WechatIMG173.jpg\" width=\"180px\"\u003e |\n| --- | --- |\n\n### 运行报错等问题\n\n首先你需要做到以下几点：\n\n- 拉取最新代码，重新安装依赖（删除 lock 文件，删除 node_modules）\n- 安装依赖时最好不要设置 npm 镜像\n- 遇到 puppeteer 安装失败设置环境变量：\n\n  ```\n  # Mac\n  export PUPPETEER_SKIP_DOWNLOAD='true'\n\n  # Windows\n  SET PUPPETEER_SKIP_DOWNLOAD='true'\n  ```\n\n- 确保你们的终端走了代理 (开全局代理，或者手动设置终端走代理)\n\n  ```sh\n  # 设置代理\n  export https_proxy=http://127.0.0.1:你的代理服务端口号;export http_proxy=http://127.0.0.1:你的代理服务端口号;export all_proxy=socks5://127.0.0.1:你的代理服务端口号\n  # 然后再执行 npm run test\n  npm run test\n  ```\n\n  ![](https://raw.githubusercontent.com/wangrongding/image-house/master/202403231002859.png)\n\n- 确保你的 openai key 有余额\n- 配置好 .env 文件\n- 执行 npm run test 能成功拿到 openai 的回复(设置完代理后，仍然请求不通？ 可以参考： https://medium.com/@chanter2d/%E5%85%B3%E4%BA%8E%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8clash%E5%AE%9E%E7%8E%B0%E7%9C%9F%E6%AD%A3%E7%9A%84%E5%85%A8%E5%B1%80%E4%BB%A3%E7%90%86-385b2d745871)\n- 执行 npm run dev 愉快的玩耍吧~ 🎉\n\n也可以参考这条 [issue](https://github.com/wangrongding/wechat-bot/issues/54#issuecomment-1347880291)\n\n- 怎么玩？ 完成自定义修改后，群聊时，在白名单中的群，有人 @你 时会触发自动回复，私聊中，联系人白名单中的人发消息给你时会触发自动回复。\n- 运行报错？检查 node 版本是否符合，如果不符合，升级 node 版本即可，检查依赖是否安装完整，如果不完整，大陆推荐切换下 npm 镜像源，然后重新安装依赖即可。（可以用我的 [prm-cli](https://github.com/wangrongding/prm-cli) 工具快速切换）\n- 调整对话模式？可以修改[openai/index.js](./src/openai/index.js) ,具体可以根据官方文档给出的示例（非常多，自己对应调整参数即可） ：https://beta.openai.com/examples\n\n## 使用 Docker 部署\n\n```sh\n$ docker build . -t wechat-bot\n\n$ docker run -d --rm --name wechat-bot -v $(pwd)/.env:/app/.env wechat-bot\n```\n\n- 如果docker build过程中node反复下载超时，可先下载nodejs镜像到本地镜像库，并将DockerFile中的'node:19'修改为本地nodejs镜像版本\n\n## Star History Chart\n\n该项目于 2023/2/13 日成为 Github Trending 榜首。\n\n[![Star History Chart](https://api.star-history.com/svg?repos=wangrongding/wechat-bot\u0026type=Date)](https://star-history.com/#wangrongding/wechat-bot\u0026Date)\n\n## License\n\n[MIT](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwangrongding%2Fwechat-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwangrongding%2Fwechat-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwangrongding%2Fwechat-bot/lists"}