如何用 TNWX 快速对接企业微信?3步实现消息推送与用户管理
【免费下载链接】TNWXTNWX: TypeScript + Node.js + WeiXin 微信系开发脚手架,支持微信公众号、微信支付、微信小游戏、微信小程序、企业微信/企业号。最最最重要的是能快速的集成至任何 Node.js 框架(Express、Nest、Egg、Koa 等)项目地址: https://gitcode.com/gh_mirrors/tn/TNWX
TNWX 是 TypeScript + Node.js 开发的微信系开发脚手架,支持企业微信、微信公众号、微信支付等多场景,能快速集成至 Express、Egg、Koa 等 Node.js 框架。本文将通过 3 个简单步骤,教你用 TNWX 实现企业微信的消息推送与用户管理功能。
1️⃣ 环境准备与项目初始化
首先需要准备 Node.js 环境(建议 v14+),然后通过 Git 克隆 TNWX 仓库:
git clone https://gitcode.com/gh_mirrors/tn/TNWX cd TNWXTNWX 采用 Lerna 进行多包管理,企业微信相关功能主要封装在packages/wxcp/模块中,包含用户管理、消息推送、部门管理等核心能力。项目结构清晰,可通过下图直观了解其模块划分:
2️⃣ 配置企业微信参数
企业微信对接需先在 企业微信管理后台 获取CorpID、应用ID(AgentID)和应用密钥(Secret)。在 TNWX 中,通过QyApiConfigKit快速配置这些参数:
import { QyApiConfigKit, ApiConfig } from 'tnwx' // 创建配置对象 const qyConfig = new ApiConfig( 'YOUR_CORPID', // 企业微信 CorpID 'YOUR_AGENTID', // 应用 ID 'YOUR_APP_SECRET' // 应用密钥 ) // 初始化配置 QyApiConfigKit.putApiConfig(qyConfig) QyApiConfigKit.setCurrentAppId(qyConfig.getAppId, qyConfig.getCorpId)配置文件通常存放在项目的初始化脚本中,例如 Egg.js 项目可参考sample/egg/app.ts,Express 项目可参考sample/express/src/App.ts。
3️⃣ 实现消息推送与用户管理
✉️ 消息推送:3行代码发送文本消息
TNWX 的QySendMsgApi封装了企业微信所有消息类型,支持文本、图片、Markdown、任务卡片等格式。以下是发送文本消息的示例:
import { QySendMsgApi, QyTextMsg, QyText } from 'tnwx' // 构建文本消息 const text = new QyTextMsg(new QyText('Hello 企业微信!这是 TNWX 发送的消息 🚀')) // 发送消息(默认推送给应用可见范围内的所有用户) const result = await QySendMsgApi.sendTextMessage(text) console.log('消息发送结果:', result)更多消息类型(如 Markdown、任务卡片)可参考sample/express/src/App.ts中的示例代码,或查阅官方文档 docs/docs/guide/wxcp/sendmsg.md。
👥 用户管理:快速获取部门成员列表
通过QyUserApi可轻松实现用户查询、创建、更新等操作。例如获取部门成员列表:
import { QyUserApi } from 'tnwx' // 获取部门 ID 为 1 的成员列表(详细信息) const users = await QyUserApi.getDepartmentUserList(1, true) console.log('部门成员:', users)用户管理的核心 API 定义在packages/wxcp/src/QyUserApi.ts,支持按部门、标签筛选用户,满足企业通讯录管理需求。
🚀 扩展场景与最佳实践
- 多应用支持:通过
QyApiConfigKit.putApiConfig可配置多个应用,使用setCurrentAppId切换上下文 - 消息回调:参考
sample/egg/app/controller/wxcp/qymsg.ts实现消息接收与被动回复 - 开发调试:设置
QyApiConfigKit.devMode = true开启调试模式,打印接口请求日志
TNWX 已在多个生产项目中验证,其模块化设计确保了代码的可维护性和扩展性。无论是内部办公系统通知,还是客户服务消息推送,都能通过简单配置快速实现。
💡 总结
通过本文的 3 个步骤,你已掌握 TNWX 对接企业微信的核心流程:环境初始化→参数配置→功能实现。TNWX 消除了微信接口的复杂性,让开发者专注于业务逻辑,是 Node.js 生态中企业微信开发的高效工具。
如果需要进一步探索高级功能(如第三方应用开发、素材管理),可查阅 packages/wxcp/ 源码或官方文档,开启企业微信开发之旅吧!
【免费下载链接】TNWXTNWX: TypeScript + Node.js + WeiXin 微信系开发脚手架,支持微信公众号、微信支付、微信小游戏、微信小程序、企业微信/企业号。最最最重要的是能快速的集成至任何 Node.js 框架(Express、Nest、Egg、Koa 等)项目地址: https://gitcode.com/gh_mirrors/tn/TNWX
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考