@jiexiaoyin/wecom-api 0.0.4 → 0.0.6

package/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: npm ci
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -28,23 +28,26 @@
 
 ## 安装
 
-### 方式一：Git 克隆
+### 方式一：npm 安装（推荐）
 
 ```bash
-# 克隆到扩展目录
-git clone https://github.com/jiexiaoyin/openclaw-wecom-api.git /root/.openclaw/extensions/wecom-api
-
-# 安装依赖
-cd /root/.openclaw/extensions/wecom-api
-npm install
+openclaw plugins install @jiexiaoyin/wecom-api
 ```
 
-### 方式二：OpenClaw CLI
+### 方式二：OpenClaw CLI（Git 克隆）
 
 ```bash
 openclaw plugins install https://github.com/jiexiaoyin/openclaw-wecom-api
 ```
 
+### 方式三：手动克隆
+
+```bash
+git clone https://github.com/jiexiaoyin/openclaw-wecom-api.git /root/.openclaw/extensions/wecom-api
+cd /root/.openclaw/extensions/wecom-api
+npm install
+```
+
 ## 配置
 
 ### 1. 修改 openclaw.json
@@ -65,6 +68,8 @@ openclaw plugins install https://github.com/jiexiaoyin/openclaw-wecom-api
 
 ### 2. 创建 config.json
 
+npm 安装方式会自动注册插件到 `openclaw.json`，但需要手动创建配置：
+
 ```bash
 cd /root/.openclaw/extensions/wecom-api
 cp config.example.json config.json
@@ -206,6 +211,11 @@ openclaw-wecom-api/
 ## 更新
 
 ```bash
+# npm 安装方式
+openclaw plugins update @jiexiaoyin/wecom-api
+systemctl --user restart openclaw-gateway
+
+# 或手动更新
 cd /root/.openclaw/extensions/wecom-api
 git pull
 npm install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jiexiaoyin/wecom-api",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "企业微信 API OpenClaw 插件，提供 32+ API 模块和事件回调处理",
   "main": "src/index.js",
   "exports": {

package/skills/wecom-api/SKILL.md

@@ -1,40 +1,164 @@
----
-name: wecom-api
-description: |
-  企业微信 API 工具库。激活当用户提到企业微信 API、wecom-api，或需要调用企业微信 API 时。
-  同时支持交互式配置：说"配置企业微信"或"设置wecom-api"来启动配置向导。
----
+# WeCom API Skill
 
-# WeCom Tool
+企业微信 API 调用技能，支持消息发送、客户管理、审批、会议、打卡、通讯录、素材等操作。
 
-企业微信 API 封装，提供 30+ 个模块的接口调用能力。
+## 触发方式
 
-## 交互式配置
+当用户提到企业微信相关操作时自动触发，如"发送消息"、"查询客户"、"创建会议"等。
 
-当用户说"配置企业微信"、"设置wecom"或"wecom配置"时，触发配置向导：
+## 参数说明
 
-```
-配置企业微信
-```
+所有参数通过自然语言传递，支持以下字段：
 
-配置向导会引导用户输入：
-1. 企业ID (corpId)
-2. 应用Secret (corpSecret)
-3. 应用AgentID (agentId)
-4. 回调Token（可选）
-5. 回调EncodingAESKey（可选）
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| userId / toUser | string | 用户ID或手机号/邮箱 |
+| externalUserId | string | 外部联系人ID |
+| agentId | string | 应用AgentID |
+| content / text | string | 消息内容 |
+| startTime / endTime | number | 时间戳（毫秒） |
+| startDate / endDate | string | 日期（YYYY-MM-DD） |
+| departmentId | number | 部门ID，默认1 |
+| filePath | string | 文件路径 |
+| chatId | string | 群ID |
 
-配置完成后会自动保存到 config.json。
+## 支持的动作
 
-## 使用示例
+### 💬 消息发送
 
-```
-# 测试连接
-/skill wecom-api test_connection
+| 动作 | 说明 |
+|------|------|
+| `send_message` | 发送文本消息（兼容旧名） |
+| `send_text` | 发送文本消息 |
+| `send_text_card` | 发送文本卡片 |
+| `send_markdown` | 发送 Markdown 消息 |
+| `send_template_card` | 发送模板卡片 |
+| `send_image` | 发送图片消息 |
+| `send_file` | 发送文件消息 |
+| `send_video` | 发送视频消息 |
+| `send_news` | 发送图文消息 |
+
+### 👥 客户联系
+
+| 动作 | 说明 |
+|------|------|
+| `get_customer_list` | 获取客户列表 |
+| `get_customer_detail` | 获取客户详情 |
+| `get_external_user_info` | 获取外部联系人信息 |
+| `batch_get_customers` | 批量获取客户详情 |
+| `update_customer_remark` | 更新客户备注 |
+| `get_corp_tags` | 获取企业标签 |
+| `add_corp_tag` | 添加企业标签 |
+| `update_corp_tag` | 更新标签 |
+| `get_groupchat_list` | 获取客户群列表 |
+| `get_groupchat` | 获取客户群详情 |
+
+### 📊 客户统计
+
+| 动作 | 说明 |
+|------|------|
+| `get_user_client_stat` | 员工客户统计数据 |
+| `get_all_user_client_stat` | 全量员工客户统计 |
+| `get_user_client_detail` | 员工客户明细 |
+| `get_group_chat_stat` | 客户群统计 |
+| `get_user_lost_stat` | 客户流失统计 |
+
+### 📋 审批
+
+| 动作 | 说明 |
+|------|------|
+| `get_approval_list` | 获取审批列表 |
+| `get_approval_detail` | 获取审批详情 |
+| `get_template_detail` | 获取审批模板详情 |
+| `submit_approval` | 提交审批 |
+| `get_leave_config` | 获取假期配置 |
+| `get_leave_balance` | 获取假期余额 |
+| `create_template` | 创建审批模板 |
+| `update_template` | 更新审批模板 |
+
+### 📅 会议
+
+| 动作 | 说明 |
+|------|------|
+| `create_meeting` | 创建会议 |
+| `get_meeting_list` | 获取会议列表 |
+| `get_meeting_detail` | 获取会议详情 |
+| `cancel_meeting` | 取消会议 |
+| `invite_meeting` | 邀请成员参会 |
+
+### 🏢 通讯录
+
+| 动作 | 说明 |
+|------|------|
+| `get_user_list` | 获取部门成员 |
+| `get_department_users_detail` | 获取部门成员详情 |
+| `get_department_list` | 获取部门列表 |
+| `get_user` | 获取用户详情 |
+| `get_user_by_mobile` | 手机号查用户 |
+| `get_user_by_email` | 邮箱查用户 |
+| `create_user` | 创建成员 |
+| `update_user` | 更新成员信息 |
+| `delete_user` | 删除成员 |
 
-# 发送消息
-/skill wecom-api send_message --userId user001 --content "Hello"
+### ⏰ 打卡
 
-# 获取客户列表
-/skill wecom-api get_customer_list --userId user001
+| 动作 | 说明 |
+|------|------|
+| `get_checkin_records` | 获取打卡记录 |
+| `get_checkin_rules` | 获取打卡规则 |
+
+### 📆 日程
+
+| 动作 | 说明 |
+|------|------|
+| `create_calendar` | 创建日历 |
+| `get_calendar` | 获取日历详情 |
+| `create_event` | 创建日程事件 |
+| `update_event` | 更新日程事件 |
+| `delete_event` | 删除日程 |
+| `add_event_attendees` | 添加参与者 |
+
+### 📁 素材
+
+| 动作 | 说明 |
+|------|------|
+| `upload_image` | 上传图片 |
+| `upload_media` | 上传媒体文件 |
+| `get_media` | 下载媒体文件 |
+| `get_high_definition_voice` | 获取高清语音 |
+
+### 📱 应用
+
+| 动作 | 说明 |
+|------|------|
+| `get_agent_list` | 获取应用列表 |
+| `get_agent` | 获取应用详情 |
+| `set_agent` | 设置应用 |
+
+### 🔧 工具
+
+| 动作 | 说明 |
+|------|------|
+| `get_token` | 获取 AccessToken |
+| `get_callback_ip` | 获取回调IP |
+
+### ⚙️ 配置
+
+| 动作 | 说明 |
+|------|------|
+| `status` / `show_config` | 查看当前配置 |
+| `test_connection` | 测试连接 |
+
+## 使用示例
+
+```
+发送消息给张三，内容是测试
+查一下张三的客户列表
+查询昨天的打卡记录
+创建一个会议，主题是周会，时间是明天下午2点
+查一下客户统计，从3月1日到3月7日
+上传图片到素材库
+获取审批列表，3月1日到3月7日
+给李四添加客户备注
+查一下客户群列表
 ```

package/skills/wecom-api/index.js

@@ -230,24 +230,132 @@ async function executeAction(action, params) {
   const wecom = getWecom();
   const args = { ...params };
   delete args.action;
-  
+
   try {
     switch (action) {
+
+      // ========== 消息发送 ==========
       case 'send_message':
         return await wecom.message.sendText(args.userId, args.content, args.agentId);
-      
+
+      case 'send_text':
+        return await wecom.message.sendText(args.toUser, args.content, args.agentId);
+
+      case 'send_text_card':
+        return await wecom.message.sendTextCard(args.toUser, args.title, args.content, args.agentId);
+
+      case 'send_markdown':
+        return await wecom.message.sendMarkdown(args.toUser, args.content, args.agentId);
+
+      case 'send_template_card':
+        return await wecom.message.sendTemplateCard(args.toUser, args.templateCard, args.agentId);
+
+      case 'send_image':
+        return await wecom.message.sendImage(args.toUser, args.mediaId, args.agentId);
+
+      case 'send_file':
+        return await wecom.message.sendFile(args.toUser, args.mediaId, args.agentId);
+
+      case 'send_video':
+        return await wecom.message.sendVideo(args.toUser, args.mediaId, args.agentId);
+
+      case 'send_news':
+        return await wecom.message.sendNews(args.toUser, args.articles, args.agentId);
+
+      // ========== 客户联系 ==========
       case 'get_customer_list':
-        return await wecom.contact.getCustomerList(args.userId);
-      
+        return await wecom.contact.getCustomerList(args.userId, args.cursor);
+
       case 'get_customer_detail':
         return await wecom.contact.getCustomerDetail(args.userId, args.externalUserId);
-      
+
+      case 'get_external_user_info':
+        return await wecom.contact.getExternalUserInfo(args.userId);
+
+      case 'batch_get_customers':
+        return await wecom.contact.batchGetCustomers(args.userId, args.externalUserIds);
+
+      case 'update_customer_remark':
+        return await wecom.contact.updateCustomerRemark(args.userId, args.externalUserId, {
+          remark: args.remark,
+          description: args.description,
+          tagIds: args.tagIds
+        });
+
+      case 'get_corp_tags':
+        return await wecom.contact.getCorpTags();
+
+      case 'add_corp_tag':
+        return await wecom.contact.addCorpTag(args.groupId, args.tagName, args.groupName);
+
+      case 'update_corp_tag':
+        return await wecom.contact.updateCorpTag(args.tagId, args.tagName);
+
+      case 'get_groupchat_list':
+        return await wecom.contact.getGroupChatList(args.statusFilter, args.creatorUserid, args.limit, args.cursor);
+
+      case 'get_groupchat':
+        return await wecom.contact.getGroupChat(args.chatId);
+
+      // ========== 客户管理（独立模块） ==========
+      case 'get_all_customers':
+        return await wecom.customer.getCustomerList(args.userid);
+
+      case 'get_all_customer_detail':
+        return await wecom.customer.getCustomerDetail(args.externalUserId);
+
+      case 'batch_get_customers_by_user':
+        return await wecom.customer.batchGetByUser(args.userids);
+
+      case 'mark_customer_tag':
+        return await wecom.customer.markTag(args.externalUserId, args.tagIds, args.userid, args.operation);
+
+      // ========== 客户统计 ==========
+      case 'get_user_client_stat':
+        return await wecom.contact_stats.getUserClientStat(args.userId, args.startDate, args.endDate);
+
+      case 'get_all_user_client_stat':
+        return await wecom.contact_stats.getAllUserClientStat(args.startDate, args.endDate);
+
+      case 'get_user_client_detail':
+        return await wecom.contact_stats.getUserClientDetail(args.userId, args.startDate, args.endDate);
+
+      case 'get_group_chat_stat':
+        return await wecom.contact_stats.getGroupChatStat(args.startDate, args.endDate, args.userId, args.departmentId);
+
+      case 'get_user_lost_stat':
+        return await wecom.contact_stats.getUserLostStat(args.startDate, args.endDate, args.userId);
+
+      // ========== 审批 ==========
       case 'get_approval_list':
-        return await wecom.approval.getApprovalIds(args.startTime, args.endTime);
-      
+        return await wecom.approval.getApprovalIds(args.startTime, args.endTime, args.cursor, args.size);
+
       case 'get_approval_detail':
         return await wecom.approval.getApprovalDetail(args.spNo);
-      
+
+      case 'get_template_detail':
+        return await wecom.approval.getTemplateDetail(args.templateId);
+
+      case 'submit_approval':
+        return await wecom.approval.submitApproval({
+          templateId: args.templateId,
+          callerUserid: args.userId,
+          ...args.approvalData
+        });
+
+      case 'get_leave_config':
+        return await wecom.approval.getLeaveConfig();
+
+      case 'get_leave_balance':
+        return await wecom.approval.getLeaveBalance(args.userId);
+
+      case 'create_template':
+        return await wecom.approval.createTemplate(args.templateData);
+
+      case 'update_template':
+        return await wecom.approval.updateTemplate(args.templateId, args.templateData);
+
+      // ========== 会议 ==========
       case 'create_meeting':
         return await wecom.meeting.createMeeting({
           topic: args.topic,
@@ -255,28 +363,125 @@ async function executeAction(action, params) {
           endTime: args.endTime,
           organizers: [args.userId]
         });
-      
+
+      case 'get_meeting_list':
+        return await wecom.meeting.getMeetingList(args.userId, args.startTime, args.endTime, args.cursor);
+
+      case 'get_meeting_detail':
+        return await wecom.meeting.getMeetingDetail(args.meetingId);
+
+      case 'cancel_meeting':
+        return await wecom.meeting.cancelMeeting(args.meetingId, args.userId);
+
+      case 'invite_meeting':
+        return await wecom.meeting.inviteMeeting(args.meetingId, args.userIds);
+
+      // ========== 通讯录 ==========
       case 'get_user_list':
         return await wecom.addressbook.getDepartmentUsers(args.departmentId || 1, args.fetchChild || false);
-      
+
+      case 'get_department_users_detail':
+        return await wecom.addressbook.getDepartmentUsersDetail(args.departmentId || 1, args.fetchChild || false);
+
       case 'get_department_list':
         return await wecom.addressbook.getDepartmentList(args.departmentId);
-      
+
+      case 'get_user':
+        return await wecom.addressbook.getUser(args.userId);
+
+      case 'get_user_by_mobile':
+        return await wecom.addressbook.getUserIdByMobile(args.mobile);
+
+      case 'get_user_by_email':
+        return await wecom.addressbook.getUserIdByEmail(args.email);
+
+      case 'create_user':
+        return await wecom.addressbook.createUser(args.userData);
+
+      case 'update_user':
+        return await wecom.addressbook.updateUser(args.userData);
+
+      case 'delete_user':
+        return await wecom.addressbook.deleteUser(args.userId);
+
+      // ========== 打卡 ==========
       case 'get_checkin_records':
         return await wecom.checkin.getCheckInRecords(args.startTime, args.endTime, args.userId);
-      
-      case 'get_corp_tags':
-        return await wecom.contact.getCorpTags();
-      
-      case 'get_groupchat_list':
-        return await wecom.contact.getGroupChatList(args.cursor, args.size);
-      
+
+      case 'get_checkin_rules':
+        return await wecom.checkin.getCheckInRules(args.groupId);
+
+      // ========== 日程 ==========
+      case 'create_calendar':
+        return await wecom.schedule.createCalendar({
+          title: args.title,
+          color: args.color,
+          description: args.description,
+          shares: args.shares || []
+        });
+
+      case 'get_calendar':
+        return await wecom.schedule.getCalendar(args.calendarId);
+
+      case 'create_event':
+        return await wecom.schedule.createEvent({
+          calendarId: args.calendarId,
+          title: args.title,
+          startTime: args.startTime,
+          endTime: args.endTime,
+          attendees: args.attendees || [],
+          description: args.description,
+          location: args.location,
+          reminders: args.reminders
+        });
+
+      case 'update_event':
+        return await wecom.schedule.updateEvent(args.scheduleId, {
+          title: args.title,
+          startTime: args.startTime,
+          endTime: args.endTime,
+          attendees: args.attendees,
+          description: args.description,
+          location: args.location
+        });
+
+      case 'delete_event':
+        return await wecom.schedule.deleteEvent(args.scheduleId);
+
+      case 'add_event_attendees':
+        return await wecom.schedule.addEventAttendees(args.scheduleId, args.attendees);
+
+      // ========== 素材 ==========
+      case 'upload_image':
+        return await wecom.media.uploadImage(args.filePath);
+
+      case 'upload_media':
+        return await wecom.media.uploadMedia(args.filePath, args.type);
+
+      case 'get_media':
+        return await wecom.media.getMedia(args.mediaId, args.savePath);
+
+      case 'get_high_definition_voice':
+        return await wecom.media.getHighDefinitionVoice(args.mediaId, args.savePath);
+
+      // ========== 应用 ==========
       case 'get_agent_list':
         return await wecom.app.getAgentList();
-      
+
+      case 'get_agent':
+        return await wecom.app.getAgent(args.agentId);
+
+      case 'set_agent':
+        return await wecom.app.setAgent(args.agentData);
+
+      // ========== 工具 ==========
       case 'get_token':
-        return await wecom.approval.getAccessToken();
-      
+        return await wecom.auth.getAccessToken();
+
+      case 'get_callback_ip':
+        return await wecom.auth.getCallbackIP();
+
+      // ========== 未知 ==========
       default:
         return { message: `未知的操作: ${action}` };
     }