Cloudflare-WX-API 是一个开源项目,托管在 GitHub 上,旨在帮助开发者将微信服务号与 Cloudflare 平台结合,实现验证码登录、扫码登录以及基于大语言模型(LLM)的智能自动回复功能。该项目由 Tinger-X 开发,适合个人开发者或小型团队快速构建微信服务号的自动化功能。项目使用 Cloudflare Workers 提供高效的服务器端支持,结合微信 API 实现用户认证和消息处理。通过集成 LLM,开发者可以实现智能化的消息回复,提升用户交互体验。整个项目以简单易用为目标,代码开放,文档清晰,适合有一定编程基础的用户。
功能列表
- 微信服务号接入:支持快速配置微信服务号,完成 API 对接。
- 验证码登录:提供基于微信的验证码登录功能,简化用户认证流程。
- 扫码登录:支持用户通过微信扫码登录,适合多种场景的快速身份验证。
- 智能自动回复:集成大语言模型(LLM),实现上下文相关的智能消息回复。
- Cloudflare Workers 支持:利用 Cloudflare 的无服务器架构,部署高效且成本低。
- 开源代码:提供完整代码和文档,方便开发者自定义功能。
- 轻量配置:通过简单的配置文件即可完成初始化设置。
使用帮助
安装与配置
要使用 Cloudflare-WX-API,首先需要准备以下环境:
- GitHub 账号:访问
https://github.com/Tinger-X/cloudflare-wx-api
,点击 “Fork” 或 “Clone” 将项目下载到本地。 - Cloudflare 账号:注册 Cloudflare 账号并开通 Workers 功能。登录 Cloudflare 仪表板,进入 “Workers” 页面,创建新项目。
- 微信开发者平台:注册微信公众平台账号,创建服务号,获取 AppID 和 AppSecret。
- Node.js 环境:确保本地安装 Node.js(建议版本 16 或以上),用于运行和测试项目。
安装步骤:
- 克隆项目到本地:
git clone https://github.com/Tinger-X/cloudflare-wx-api.git cd cloudflare-wx-api
- 安装依赖:
npm install
- 配置环境变量:
- 在项目根目录创建
.env
文件,添加以下内容:WECHAT_APP_ID=你的微信AppID WECHAT_APP_SECRET=你的微信AppSecret CLOUDFLARE_API_TOKEN=你的Cloudflare API令牌 LLM_API_KEY=你的LLM服务API密钥
- 在项目根目录创建
- 部署到 Cloudflare Workers:
- 使用 Wrangler CLI 工具(Cloudflare 的命令行工具)登录:
npx wrangler login
- 部署项目:
npx wrangler deploy
- 部署完成后,Wrangler 会返回一个 URL(如
https://your-project.workers.dev
),用于微信服务号配置。
- 使用 Wrangler CLI 工具(Cloudflare 的命令行工具)登录:
微信服务号配置:
- 登录微信公众平台,进入 “开发 – 基本配置”。
- 在 “服务器配置” 中,填写以下内容:
- 服务器地址(URL):填入 Cloudflare Workers 提供的 URL。
- 令牌(Token):在项目配置文件中自定义设置。
- 消息加解密密钥:生成随机密钥并保存。
- 提交配置并验证,确认服务器与微信服务号成功连接。
功能操作流程
验证码登录
- 用户在前端触发登录请求,系统向用户微信发送验证码。
- 用户输入验证码,项目通过
/verify
端点校验验证码。 - 验证成功后,返回用户认证信息(如 OpenID),用于后续操作。
- 操作示例:用户访问你的网页,点击 “微信登录”,输入收到的验证码,系统自动完成身份验证。
扫码登录
- 项目生成动态二维码,用户使用微信扫描。
- 扫描后,微信服务器回调项目配置的 URL,传递用户身份信息。
- 系统处理回调,完成用户登录。
- 操作示例:用户扫描网页上的二维码,微信跳转授权页面,确认后自动登录。
智能自动回复
- 用户向微信服务号发送消息,触发 Cloudflare Workers 处理。
- 项目调用 LLM API(如 OpenAI 或其他模型),生成上下文相关的回复。
- 回复通过微信 API 返回给用户。
- 操作示例:用户发送 “明天天气如何?”,服务号回复 “请输入城市名称,我将为你查询天气” 或直接返回天气信息。
自定义功能
开发者可修改 index.js
文件,添加自定义逻辑。例如,增加消息过滤、关键词触发或多语言支持。项目支持模块化扩展,开发者可根据需求接入其他 API。
注意事项
- 安全性:确保
.env
文件中的密钥不泄露,避免上传到公共仓库。 - 调试:使用
npx wrangler dev
在本地测试 Workers 功能。 - 文档参考:项目 GitHub 页面提供详细文档,位于
README.md
和DOCS
文件夹。 - 更新维护:定期检查 Cloudflare Workers 和微信 API 的版本兼容性。
应用场景
- 个人开发者快速搭建微信服务号
个人开发者可利用 Cloudflare-WX-API 快速实现微信服务号的登录和消息回复功能,无需复杂服务器配置,适合快速原型开发。 - 电商平台用户认证
电商网站可通过扫码登录或验证码登录简化用户认证流程,提升用户体验,降低注册门槛。 - 智能客服系统
企业可使用智能自动回复功能,搭建 24/7 客服系统,回答常见问题,减轻人工客服负担。 - 教育或社区互动平台
在线教育或社区平台可通过微信服务号与用户互动,推送课程提醒或活动通知,并通过 LLM 提供个性化回复。
QA
- 需要服务器吗?
不需要。项目基于 Cloudflare Workers,无需传统服务器,部署简单且成本低。 - 支持哪些大语言模型?
项目支持任意提供 API 的 LLM,如 OpenAI、Anthropic 等,需在.env
中配置 API 密钥。 - 如何调试微信回调?
使用npx wrangler dev
启动本地服务器,结合微信公众平台测试号验证回调功能。 - 是否支持多语言回复?
默认支持中文回复,开发者可修改代码,接入多语言 LLM 或翻译 API。