@gloablehive/celphone-wechat-plugin 1.0.0

package/dist/src/client.js

@@ -0,0 +1,248 @@
+/**
+ * WorkPhone WeChat API Client
+ *
+ * Interfaces with the WorkPhone API for sending/receiving WeChat messages
+ * Based on the Apifox API manual: data/apifox-workphone-3/
+ */
+export class WorkPhoneWeChatClient {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    async request(method, path, body, query) {
+        const url = new URL(`${this.config.baseUrl}${path}`);
+        if (query) {
+            Object.entries(query).forEach(([k, v]) => url.searchParams.append(k, v));
+        }
+        const headers = {
+            'Authorization': `Bearer ${this.config.apiKey}`,
+            'Content-Type': 'application/json',
+        };
+        if (this.config.accountId) {
+            headers['X-Account-Id'] = this.config.accountId;
+        }
+        const response = await fetch(url.toString(), {
+            method,
+            headers,
+            body: body ? JSON.stringify(body) : undefined,
+        });
+        if (!response.ok) {
+            const error = await response.text();
+            throw new Error(`WorkPhone API error: ${response.status} - ${error}`);
+        }
+        return response.json();
+    }
+    // ========== WeChat Account Operations ==========
+    /**
+     * Get all WeChat accounts for an account
+     * GET /api/v1/accounts/{accountId}/wechatAccounts
+     */
+    async getWeChatAccounts(accountId) {
+        return this.request('GET', `/api/v1/accounts/${accountId}/wechatAccounts`);
+    }
+    /**
+     * Get WeChat account info by wechatId
+     * GET /wp/api/v1/wechatAccounts/{wechatId}/byWechatId
+     */
+    async getWeChatAccountById(wechatId) {
+        return this.request('GET', `/wp/api/v1/wechatAccounts/${wechatId}/byWechatId`);
+    }
+    // ========== Friend Operations ==========
+    /**
+     * Get all friends for a WeChat account
+     * GET /wp/api/v1/wechatAccounts/{wechatAccountId}/friends
+     */
+    async getFriends(wechatAccountId, options) {
+        return this.request('GET', `/wp/api/v1/wechatAccounts/${wechatAccountId}/friends`, undefined, options);
+    }
+    /**
+     * Search friends
+     * GET /wp/api/v1/wechatFriends
+     */
+    async searchFriends(params) {
+        return this.request('GET', '/wp/api/v1/wechatFriends', undefined, params);
+    }
+    /**
+     * Get friend by ID
+     * GET /wp/api/v1/wechatFriends/{wechatFriendId}
+     */
+    async getFriend(wechatFriendId) {
+        return this.request('GET', `/wp/api/v1/wechatFriends/${wechatFriendId}`);
+    }
+    /**
+     * Add friend (send friend request)
+     * POST /wp/api/v1/wechatFriends/addFriend
+     */
+    async addFriend(params) {
+        return this.request('POST', '/wp/api/v1/wechatFriends/addFriend', params);
+    }
+    /**
+     * Accept friend request
+     * POST /wp/api/v1/wechatFriends/{wechatFriendId}/acceptFriend
+     */
+    async acceptFriend(wechatFriendId) {
+        return this.request('POST', `/wp/api/v1/wechatFriends/${wechatFriendId}/acceptFriend`);
+    }
+    /**
+     * Update friend remark
+     * PUT /wp/api/v1/wechatFriends/{wechatFriendId}/remark
+     */
+    async updateFriendRemark(wechatFriendId, remark) {
+        return this.request('PUT', `/wp/api/v1/wechatFriends/${wechatFriendId}/remark`, { remark });
+    }
+    /**
+     * Update friend labels
+     * PUT /wp/api/v1/wechatFriends/{wechatFriendId}/label
+     */
+    async updateFriendLabels(wechatFriendId, labelIds) {
+        return this.request('PUT', `/wp/api/v1/wechatFriends/${wechatFriendId}/label`, { labelIds });
+    }
+    // ========== Chatroom (Group) Operations ==========
+    /**
+     * Get all chatrooms for a WeChat account
+     * GET /wp/api/v1/wechatAccounts/{wechatAccountId}/chatrooms
+     */
+    async getChatrooms(wechatAccountId) {
+        return this.request('GET', `/wp/api/v1/wechatAccounts/${wechatAccountId}/chatrooms`);
+    }
+    /**
+     * Get chatroom info by chatroomId
+     * GET /wp/api/v1/wechatChatrooms/{wechatChatroomId}
+     */
+    async getChatroom(wechatChatroomId) {
+        return this.request('GET', `/wp/api/v1/wechatChatrooms/${wechatChatroomId}`);
+    }
+    /**
+     * Update chatroom name (announcement)
+     * PUT /wp/api/v1/wechatChatrooms/{wechatChatroomId}/chatroomName
+     */
+    async updateChatroomName(wechatChatroomId, name) {
+        return this.request('PUT', `/wp/api/v1/wechatChatrooms/${wechatChatroomId}/chatroomName`, { name });
+    }
+    /**
+     * Publish chatroom announcement
+     * PUT /api/v1/wechat/chatroom/announcement
+     */
+    async publishChatroomAnnouncement(wechatChatroomId, content) {
+        return this.request('PUT', '/api/v1/wechat/chatroom/announcement', {
+            wechatChatroomId,
+            content,
+        });
+    }
+    // ========== Message Operations ==========
+    /**
+     * Get friend messages (1-on-1 chat)
+     * GET /wp/api/v1/wechat/friendMessages
+     */
+    async getFriendMessages(params) {
+        return this.request('GET', '/wp/api/v1/wechat/friendMessages', undefined, params);
+    }
+    /**
+     * Get chatroom messages (group chat)
+     * GET /wp/api/v1/wechat/chatroomMessages
+     */
+    async getChatroomMessages(params) {
+        return this.request('GET', '/wp/api/v1/wechat/chatroomMessages', undefined, params);
+    }
+    /**
+     * Send friend message (1-on-1)
+     * POST /wp/api/v1/wechat/friendMessages
+     */
+    async sendFriendMessage(params) {
+        return this.request('POST', '/wp/api/v1/wechat/friendMessages', params);
+    }
+    /**
+     * Send chatroom message (group)
+     * POST /wp/api/v1/wechat/chatroomMessages
+     */
+    async sendChatroomMessage(params) {
+        return this.request('POST', '/wp/api/v1/wechat/chatroomMessages', params);
+    }
+    // ========== Moments (朋友圈) Operations ==========
+    /**
+     * Get moments
+     * GET /wp/api/v1/moments
+     */
+    async getMoments(params) {
+        return this.request('GET', '/wp/api/v1/moments', undefined, params);
+    }
+    /**
+     * Publish moment (post to Moments)
+     * POST /wp/api/v1/moments
+     */
+    async publishMoment(params) {
+        return this.request('POST', '/wp/api/v1/moments', params);
+    }
+    /**
+     * Comment on a moment
+     * POST /wp/api/v1/moments/{momentId}/comment
+     */
+    async commentMoment(momentId, content, replyCommentId) {
+        return this.request('POST', `/wp/api/v1/moments/${momentId}/comment`, {
+            content,
+            replyCommentId,
+        });
+    }
+    /**
+     * Like a moment
+     * POST /wp/api/v1/moments/{momentId}/like
+     */
+    async likeMoment(momentId) {
+        return this.request('POST', `/wp/api/v1/moments/${momentId}/like`);
+    }
+    // ========== Media Download ==========
+    /**
+     * Download friend message file
+     */
+    async downloadFriendFile(messageId, wechatTime) {
+        const url = `${this.config.baseUrl}/wp/api/v1/wechat/friendMessage/downloadFile/${messageId}/${wechatTime}`;
+        const response = await fetch(url, {
+            headers: { 'Authorization': `Bearer ${this.config.apiKey}` },
+        });
+        if (!response.ok) {
+            throw new Error(`Download failed: ${response.status}`);
+        }
+        return response.blob();
+    }
+    /**
+     * Download chatroom message file
+     */
+    async downloadChatroomFile(messageId, wechatTime) {
+        const url = `${this.config.baseUrl}/wp/api/v1/wechat/chatroomMessage/downloadFile/${messageId}/${wechatTime}`;
+        const response = await fetch(url, {
+            headers: { 'Authorization': `Bearer ${this.config.apiKey}` },
+        });
+        if (!response.ok) {
+            throw new Error(`Download failed: ${response.status}`);
+        }
+        return response.blob();
+    }
+    // ========== Webhook Parsing ==========
+    /**
+     * Parse webhook payload from WorkPhone callback
+     * This should be called by your webhook endpoint handler
+     */
+    parseWebhookPayload(payload) {
+        // WorkPhone webhook format - adjust based on actual webhook docs
+        const eventMap = {
+            'msg': 'message',
+            'friend_request': 'friend_request',
+            'group_invite': 'group_invite',
+            'system': 'system',
+        };
+        return {
+            event: eventMap[payload.event] || 'message',
+            accountId: payload.accountId || '',
+            wechatAccountId: payload.wechatAccountId || '',
+            message: payload.message,
+            friendRequest: payload.friendRequest,
+            timestamp: payload.timestamp || Date.now(),
+        };
+    }
+}
+/**
+ * Factory function to create a WorkPhone client from OpenClaw config
+ */
+export function createWorkPhoneClient(config) {
+    return new WorkPhoneWeChatClient(config);
+}

package/index-simple.ts

@@ -0,0 +1,11 @@
+/**
+ * OpenClaw Channel Plugin Entry Point - Simplified Version
+ *
+ * WorkPhone WeChat Plugin - 最小可运行版本
+ */
+
+import { celPhoneWeChatPlugin } from "./src/channel.js";
+
+// 直接导出插件，不使用复杂包装
+export default celPhoneWeChatPlugin;
+export { celPhoneWeChatPlugin };

package/index.ts

@@ -0,0 +1,89 @@
+/**
+ * OpenClaw Channel Plugin Entry Point
+ *
+ * WorkPhone WeChat Plugin - enables OpenClaw to send/receive WeChat messages
+ * through the WorkPhone API platform.
+ */
+
+import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core";
+import { celPhoneWeChatPlugin, handleInboundMessage } from "./src/channel.js";
+
+export default defineChannelPluginEntry({
+  id: "celphone-wechat",
+  name: "WorkPhone WeChat",
+  description: "Connect OpenClaw to WorkPhone WeChat API for sending and receiving WeChat messages",
+  plugin: celPhoneWeChatPlugin,
+
+  registerCliMetadata(api) {
+    api.registerCli(
+      ({ program }) => {
+        program
+          .command("celphone-wechat")
+          .description("WorkPhone WeChat channel management")
+          .option("-a, --account <id>", "WeChat account ID")
+          .option("-l, --list", "List configured WeChat accounts");
+      },
+      {
+        descriptors: [
+          {
+            name: "celphone-wechat",
+            description: "WorkPhone WeChat channel",
+            hasSubcommands: true,
+          },
+        ],
+      }
+    );
+  },
+
+  registerFull(api) {
+    // Register webhook endpoint for receiving messages from WorkPhone
+    api.registerHttpRoute({
+      path: "/celphone-wechat/webhook",
+      auth: "plugin", // Plugin-managed auth - verify signatures yourself
+      handler: async (req, res) => {
+        try {
+          // Parse the webhook payload
+          // The exact format depends on WorkPhone's webhook configuration
+          const payload = req.body;
+
+          // Verify the request is from WorkPhone
+          // Add signature verification here if needed
+          const signature = req.headers["x-workphone-signature"];
+          if (!signature) {
+            res.statusCode = 401;
+            res.end("Missing signature");
+            return true;
+          }
+
+          // Handle the inbound message
+          await handleInboundMessage(api, payload);
+
+          res.statusCode = 200;
+          res.end("ok");
+          return true;
+        } catch (error) {
+          console.error("Webhook error:", error);
+          res.statusCode = 500;
+          res.end("Internal error");
+          return true;
+        }
+      },
+    });
+
+    // Register gateway method for outbound media handling
+    api.registerGatewayMethod({
+      method: "POST",
+      path: "/celphone-wechat/media",
+      handler: async (req, res) => {
+        const { messageId, mediaUrl, mediaType } = req.body;
+
+        // Handle media upload/send through WorkPhone
+        // This is called when the bot needs to send media files
+
+        res.statusCode = 200;
+        res.json({ success: true, messageId });
+        return true;
+      },
+    });
+  },
+});

package/mock-server.ts

@@ -0,0 +1,237 @@
+/**
+ * Mock WorkPhone API Server for Testing
+ *
+ * 模拟 WorkPhone 的 API 端点，用于本地测试
+ */
+
+import express from 'express';
+import { createServer } from 'http';
+
+const app = express();
+app.use(express.json());
+
+// 配置
+const MOCK_CONFIG = {
+  apiKey: 'test-api-key-12345',
+  wechatAccountId: 'mock-wechat-001',
+  wechatId: 'wxid_mock001',
+  baseUrl: 'http://localhost:18999',
+};
+
+// 存储消息
+const messages: any[] = [];
+const friends: any[] = [
+  { wechatId: 'wxid_customer001', remark: '客户A', nickname: '张三' },
+  { wechatId: 'wxid_customer002', remark: '客户B', nickname: '李四' },
+  { wechatId: 'wxid_customer003', remark: '潜在客户', nickname: '王五' },
+];
+
+// ============ API 端点 ============
+
+// 健康检查
+app.get('/health', (req, res) => {
+  res.json({ status: 'ok' });
+});
+
+// 获取账号列表
+app.get('/api/v1/wechat/accounts', (req, res) => {
+  const auth = req.headers.authorization;
+  if (auth !== `Bearer ${MOCK_CONFIG.apiKey}`) {
+    return res.status(401).json({ error: 'unauthorized' });
+  }
+
+  res.json({
+    data: [
+      {
+        accountId: MOCK_CONFIG.wechatAccountId,
+        wechatId: MOCK_CONFIG.wechatId,
+        nickname: '测试客服',
+        status: 'online',
+      }
+    ]
+  });
+});
+
+// 获取好友列表
+app.get(`/api/v1/wechat/accounts/${MOCK_CONFIG.wechatAccountId}/friends`, (req, res) => {
+  const auth = req.headers.authorization;
+  if (auth !== `Bearer ${MOCK_CONFIG.apiKey}`) {
+    return res.status(401).json({ error: 'unauthorized' });
+  }
+
+  res.json({ data: friends });
+});
+
+// 发送好友消息
+app.post(`/api/v1/wechat/accounts/${MOCK_CONFIG.wechatAccountId}/messages/friend`, (req, res) => {
+  const auth = req.headers.authorization;
+  if (auth !== `Bearer ${MOCK_CONFIG.apiKey}`) {
+    return res.status(401).json({ error: 'unauthorized' });
+  }
+
+  const { friendWechatId, content, type } = req.body;
+
+  console.log(`[Mock] 发送消息给 ${friendWechatId}: ${content}`);
+
+  const messageId = `msg_${Date.now()}`;
+  messages.push({
+    messageId,
+    friendWechatId,
+    content,
+    type,
+    timestamp: Date.now(),
+    direction: 'outbound',
+  });
+
+  res.json({
+    code: 0,
+    message: 'success',
+    data: {
+      messageId,
+      msgSvrId: `svr_${Date.now()}`,
+    }
+  });
+});
+
+// 发送群消息
+app.post(`/api/v1/wechat/accounts/${MOCK_CONFIG.wechatAccountId}/messages/chatroom`, (req, res) => {
+  const auth = req.headers.authorization;
+  if (auth !== `Bearer ${MOCK_CONFIG.apiKey}`) {
+    return res.status(401).json({ error: 'unauthorized' });
+  }
+
+  const { chatroomId, content, type, atUsers } = req.body;
+
+  console.log(`[Mock] 发送消息到群 ${chatroomId}: ${content}`);
+
+  const messageId = `msg_${Date.now()}`;
+  messages.push({
+    messageId,
+    chatroomId,
+    content,
+    type,
+    atUsers,
+    timestamp: Date.now(),
+    direction: 'outbound',
+  });
+
+  res.json({
+    code: 0,
+    message: 'success',
+    data: {
+      messageId,
+      msgSvrId: `svr_${Date.now()}`,
+    }
+  });
+});
+
+// Webhook 配置（返回当前 webhook 地址）
+app.get(`/api/v1/wechat/accounts/${MOCK_CONFIG.wechatAccountId}/webhook`, (req, res) => {
+  res.json({
+    data: {
+      url: 'http://localhost:18999/webhook',
+      enabled: true,
+    }
+  });
+});
+
+// 设置 webhook
+app.put(`/api/v1/wechat/accounts/${MOCK_CONFIG.wechatAccountId}/webhook`, (req, res) => {
+  const { url } = req.body;
+  console.log(`[Mock] Webhook 设置为: ${url}`);
+  res.json({ code: 0, message: 'success' });
+});
+
+// ============ Webhook 模拟触发 ============
+
+// 模拟收到好友消息
+app.post('/mock/trigger/friend-message', (req, res) => {
+  const { wechatId, content } = req.body;
+
+  const payload = {
+    event: 'message',
+    accountId: MOCK_CONFIG.wechatAccountId,
+    wechatAccountId: MOCK_CONFIG.wechatAccountId,
+    message: {
+      messageId: `in_msg_${Date.now()}`,
+      msgSvrId: `svr_${Date.now()}`,
+      fromUser: wechatId || 'wxid_customer001',
+      toUser: MOCK_CONFIG.wechatId,
+      content: content || '你好，这是测试消息',
+      type: 1,
+      timestamp: Date.now(),
+      isSelf: false,
+    }
+  };
+
+  // 回调（如果配置了 webhook）
+  // 实际使用时会让用户配置真实的 webhook URL
+
+  res.json({
+    code: 0,
+    message: 'triggered',
+    payload
+  });
+});
+
+// 模拟收到群消息
+app.post('/mock/trigger/chatroom-message', (req, res) => {
+  const { chatroomId, content } = req.body;
+
+  const payload = {
+    event: 'message',
+    accountId: MOCK_CONFIG.wechatAccountId,
+    wechatAccountId: MOCK_CONFIG.wechatAccountId,
+    message: {
+      messageId: `in_msg_${Date.now()}`,
+      msgSvrId: `svr_${Date.now()}`,
+      fromUser: 'wxid_customer001',
+      chatroomId: chatroomId || '123456789@chatroom',
+      content: content || '大家好',
+      type: 1,
+      timestamp: Date.now(),
+      isSelf: false,
+    }
+  };
+
+  res.json({
+    code: 0,
+    message: 'triggered',
+    payload
+  });
+});
+
+// 获取消息历史
+app.get('/mock/messages', (req, res) => {
+  res.json({ data: messages });
+});
+
+// 启动服务器
+const PORT = 18999;
+const server = createServer(app);
+
+server.listen(PORT, () => {
+  console.log(`
+╔═══════════════════════════════════════════════════════════╗
+║           Mock WorkPhone API Server                        ║
+╠═══════════════════════════════════════════════════════════╣
+║  Base URL: http://localhost:${PORT}                          ║
+║  API Key:  ${MOCK_CONFIG.apiKey}                          ║
+║  WeChat Account: ${MOCK_CONFIG.wechatAccountId}                         ║
+╠═══════════════════════════════════════════════════════════╣
+║  测试端点:                                                 ║
+║  - POST /mock/trigger/friend-message  模拟好友消息          ║
+║  - POST /mock/trigger/chatroom-message 模拟群消息          ║
+║  - GET /mock/messages 查看消息历史                        ║
+╚═══════════════════════════════════════════════════════════╝
+  `);
+});
+
+// 优雅关闭
+process.on('SIGINT', () => {
+  console.log('\n[Mock] 关闭服务器...');
+  server.close(() => {
+    console.log('[Mock] 服务器已关闭');
+    process.exit(0);
+  });
+});

package/openclaw.plugin.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "https://openclaw.ai/schema/plugin.json",
+  "id": "celphone-wechat",
+  "name": "WorkPhone WeChat",
+  "version": "1.0.0",
+  "description": "Connect OpenClaw to WorkPhone WeChat API for sending and receiving WeChat messages",
+  "author": {
+    "name": "gloablehive",
+    "url": "https://github.com/gloablehive"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gloablehive/channels/celphone-wechat-plugin"
+  },
+  "keywords": ["openclaw", "channel", "wechat", "workphone", "messaging"],
+  "license": "MIT",
+  "type": "channel",
+  "capabilities": {
+    "inbound": {
+      "message": true,
+      "friend_request": true,
+      "group_invite": false
+    },
+    "outbound": {
+      "text": true,
+      "media": true,
+      "link": true,
+      "location": true,
+      "contact": true
+    },
+    "features": {
+      "pairing": false,
+      "reactions": false,
+      "editing": false,
+      "deleting": false,
+      "threads": true
+    }
+  },
+  "config": {
+    "type": "object",
+    "properties": {
+      "apiKey": {
+        "type": "string",
+        "description": "WorkPhone API key for authentication",
+        "secret": true,
+        "required": true
+      },
+      "baseUrl": {
+        "type": "string",
+        "description": "WorkPhone API base URL",
+        "default": "https://api.workphone.example.com"
+      },
+      "accountId": {
+        "type": "string",
+        "description": "WorkPhone account ID"
+      },
+      "wechatAccountId": {
+        "type": "string",
+        "description": "WeChat account ID to use (from WorkPhone) - REQUIRED",
+        "required": true
+      },
+      "wechatId": {
+        "type": "string",
+        "description": "The actual WeChat ID (wxid_xxx) for this account"
+      },
+      "nickName": {
+        "type": "string",
+        "description": "Display name for this WeChat account"
+      },
+      "allowFrom": {
+        "type": "array",
+        "items": { "type": "string" },
+        "description": "List of WeChat IDs that can DM the agent",
+        "default": []
+      },
+      "dmSecurity": {
+        "type": "string",
+        "enum": ["allowlist", "blocklist", "allowall"],
+        "description": "DM security policy",
+        "default": "allowlist"
+      },
+      "webhookSecret": {
+        "type": "string",
+        "description": "Secret for verifying webhook requests",
+        "secret": true
+      }
+    },
+    "required": ["apiKey", "wechatAccountId"]
+  },
+  "permissions": {
+    "channels": ["celphone-wechat"],
+    "http": {
+      "outbound": ["*"],
+      "inbound": ["/celphone-wechat/webhook"]
+    }
+  },
+  "apiVersion": "1.0.0"
+}