@jiexiaoyin/wecom-api 0.0.2

package/src/modules/moments/index.js

@@ -0,0 +1,161 @@
+/**
+ * 客户朋友圈模块
+ * API 章节：十三 - 客户朋友圈
+ * 包含：发表朋友圈、停止发表、获取记录等
+ */
+
+const WeComSDK = require('../../sdk');
+
+class Moments extends WeComSDK {
+  constructor(config) {
+    super(config);
+  }
+
+  // ========== 朋友圈内容管理 ==========
+
+  /**
+   * 企业发表内容到客户的朋友圈
+   * @param {string} userId 成员 ID
+   * @param {object} content 朋友圈内容
+   */
+  async createMoment(userId, content) {
+    const { text, imageIds, videoId, link, location } = content;
+    return this.post('/externalcontact/add_moment_task', {
+      userid: userId,
+      moment_type: 1,
+      moment_content: {
+        text,
+        image: imageIds || [],
+        video: videoId,
+        link: link,
+        location: location
+      }
+    });
+  }
+
+  /**
+   * 获取客户朋友圈全部的发表记录
+   * @param {string} userId 成员 ID
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   * @param {number} cursor 分页游标
+   * @param {number} size 每页数量
+   */
+  async getMomentList(userId, startTime, endTime, cursor = '', size = 100) {
+    return this.post('/externalcontact/get_moment_list', {
+      userid: userId,
+      start_time: startTime,
+      end_time: endTime,
+      cursor,
+      limit: size
+    });
+  }
+
+  /**
+   * 获取客户朋友圈发表结果
+   * @param {string} momentId 朋友圈 ID
+   * @param {string} userId 成员 ID
+   */
+  async getMomentTaskResult(momentId, userId) {
+    return this.post('/externalcontact/get_moment_task_result', {
+      moment_id: momentId,
+      userid: userId
+    });
+  }
+
+  /**
+   * 获取朋友圈互动数据
+   * @param {string} momentId 朋友圈 ID
+   * @param {string} userId 成员 ID
+   */
+  async getMomentComments(momentId, userId) {
+    return this.post('/externalcontact/get_moment_comments', {
+      moment_id: momentId,
+      userid: userId
+    });
+  }
+
+  /**
+   * 删除朋友圈
+   * @param {string} momentId 朋友圈 ID
+   * @param {string} userId 成员 ID
+   */
+  async deleteMoment(momentId, userId) {
+    return this.post('/externalcontact/del_moment', {
+      moment_id: momentId,
+      userid: userId
+    });
+  }
+
+  // ========== 朋友圈规则管理 ==========
+
+  /**
+   * 获取朋友圈规则组列表
+   */
+  async getMomentRuleList() {
+    return this.post('/externalcontact/get_moment_rule_list', {});
+  }
+
+  /**
+   * 获取朋友圈规则组详情
+   * @param {string} ruleId 规则组 ID
+   */
+  async getMomentRuleDetail(ruleId) {
+    return this.post('/externalcontact/get_moment_rule', { rule_id: ruleId });
+  }
+
+  /**
+   * 创建朋友圈规则组
+   * @param {object} rule 规则配置
+   */
+  async createMomentRule(rule) {
+    return this.post('/externalcontact/add_moment_rule', rule);
+  }
+
+  /**
+   * 更新朋友圈规则组
+   * @param {string} ruleId 规则组 ID
+   * @param {object} rule 规则配置
+   */
+  async updateMomentRule(ruleId, rule) {
+    return this.post('/externalcontact/update_moment_rule', {
+      rule_id: ruleId,
+      ...rule
+    });
+  }
+
+  /**
+   * 删除朋友圈规则组
+   * @param {string} ruleId 规则组 ID
+   */
+  async deleteMomentRule(ruleId) {
+    return this.post('/externalcontact/del_moment_rule', { rule_id: ruleId });
+  }
+
+  // ========== 朋友圈素材管理 ==========
+
+  /**
+   * 获取朋友圈素材列表
+   * @param {string} type 素材类型: image, video
+   * @param {number} offset 偏移量
+   * @param {number} size 每页数量
+   */
+  async getMomentMediaList(type = 'image', offset = 0, size = 100) {
+    return this.post('/externalcontact/get_moment_media_list', {
+      type,
+      offset,
+      limit: size
+    });
+  }
+
+  /**
+   * 上传朋友圈素材
+   * @param {string} filePath 文件路径
+   * @param {string} type 素材类型: image, video
+   */
+  async uploadMomentMedia(filePath, type = 'image') {
+    return this.uploadFile(filePath, 'media', { type });
+  }
+}
+
+module.exports = Moments;

package/src/modules/msgaudit/index.js

@@ -0,0 +1,24 @@
+const WeComSDK = require("../../sdk");
+
+class Msgaudit extends WeComSDK {
+    /** 获取会话内容存档开启成员列表 */
+    async getPermitUserList() {
+        return this.post("/msgaudit/get_permit_user_list", {});
+    }
+
+    /** 获取会话内容存档 */
+    async getChatData(chatIdList, seq, limit) {
+        return this.post("/msgaudit/chatrecord/get", {
+            chat_id_list: chatIdList,
+            seq: seq !== undefined ? seq : 0,
+            limit: limit || 100
+        });
+    }
+
+    /** 获取客户同意进行聊天内容存档的情况 */
+    async checkSingleAgree(userids) {
+        return this.post("/msgaudit/check_single_agree", { userid_list: userids });
+    }
+}
+
+module.exports = Msgaudit;

package/src/modules/notify/index.js

@@ -0,0 +1,81 @@
+/**
+ * 紧急通知模块
+ * API 章节：二十七 - 紧急通知应用
+ * 包含：发起语音电话、获取接听状态
+ */
+
+const WeComSDK = require('../../sdk');
+
+class Notify extends WeComSDK {
+  constructor(config) {
+    super(config);
+  }
+
+  /**
+   * 发起语音电话
+   * @param {string} userId 成员 ID
+   * @param {string[]} toUsers 被通知成员列表
+   * @param {string} prompt 提示音类型: greeting-欢迎提示音, notice-到期提醒
+   */
+  async sendVoiceCall(userId, toUsers, prompt = 'notice') {
+    return this.post('/ instantservice/voicenotify', {
+      userid: userId,
+      to_user: toUsers,
+      prompt
+    });
+  }
+
+  /**
+   * 批量发起语音电话
+   * @param {string} userId 成员 ID
+   * @param {string[]} toUsers 被通知成员列表
+   * @param {string} prompt 提示音类型
+   */
+  async batchSendVoiceCall(userId, toUsers, prompt = 'notice') {
+    return this.sendVoiceCall(userId, toUsers, prompt);
+  }
+
+  /**
+   * 获取语音通知状态
+   * @param {string} notifyId 通知 ID
+   */
+  async getVoiceNotifyStatus(notifyId) {
+    return this.post('/ instantservice/voiceNotify/status', { notify_id: notifyId });
+  }
+
+  // ========== 企业提醒通知 ==========
+
+  /**
+   * 发送企业提醒
+   * @param {string} userId 成员 ID
+   * @param {string} content 提醒内容
+   * @param {string[]} toUsers 通知成员列表
+   */
+  async sendCorpReminder(userId, content, toUsers) {
+    return this.post('/ instantservice/corp_reminder', {
+      userid: userId,
+      content,
+      to_users: toUsers
+    });
+  }
+
+  // ========== 工作通知提醒 ==========
+
+  /**
+   * 发送工作通知提醒
+   * @param {string} userId 成员 ID
+   * @param {string} content 提醒内容
+   * @param {string[]} toUsers 通知成员列表
+   * @param {number} agentId 应用 ID
+   */
+  async sendWorkNoticeReminder(userId, content, toUsers, agentId) {
+    return this.post('/ instantservice/worknotice_reminder', {
+      userid: userId,
+      content,
+      to_users: toUsers,
+      agentid: agentId
+    });
+  }
+}
+
+module.exports = Notify;

package/src/modules/oceanengine/index.js

@@ -0,0 +1,199 @@
+/**
+ * 获客助手模块
+ * API 章节：十三 - 获客助手
+ * 包含：获客链接管理、额度管理、广告优化等
+ */
+
+const WeComSDK = require('../../sdk');
+
+class OceanEngine extends WeComSDK {
+  constructor(config) {
+    super(config);
+  }
+
+  // ========== 获客链接管理 ==========
+
+  /**
+   * 创建获客链接
+   * @param {string} name 链接名称
+   * @param {string} intro 链接简介
+   * @param {string} userId 成员 ID
+   * @param {string} type 链接类型: 1-联系我 2-加入群聊
+   * @param {string} contentId 联系我或群聊 ID
+   */
+  async createAcquisitionLink(name, intro, userId, type = 1, contentId) {
+    return this.post('/externalcontact/acquisition/link/add', {
+      name,
+      intro,
+      user_id: userId,
+      type,
+      content_id: contentId
+    });
+  }
+
+  /**
+   * 获取获客链接列表
+   * @param {number} offset 偏移量
+   * @param {number} size 每页数量
+   */
+  getAcquisitionLinkList(offset = 0, size = 100) {
+    return this.post('/externalcontact/acquisition/link/list', {
+      offset,
+      limit: size
+    });
+  }
+
+  /**
+   * 获取获客链接详情
+   * @param {string} linkId 链接 ID
+   */
+  getAcquisitionLinkDetail(linkId) {
+    return this.post('/externalcontact/acquisition/link/get', {
+      link_id: linkId
+    });
+  }
+
+  /**
+   * 更新获客链接
+   * @param {string} linkId 链接 ID
+   * @param {object} params 更新参数
+   */
+  updateAcquisitionLink(linkId, { name, intro, state }) {
+    return this.post('/externalcontact/acquisition/link/update', {
+      link_id: linkId,
+      name,
+      intro,
+      state
+    });
+  }
+
+  /**
+   * 删除获客链接
+   * @param {string} linkId 链接 ID
+   */
+  deleteAcquisitionLink(linkId) {
+    return this.post('/externalcontact/acquisition/link/del', {
+      link_id: linkId
+    });
+  }
+
+  // ========== 获客助手额度管理 ==========
+
+  /**
+   * 获取成员收客链接收客总数
+   * @param {string} userId 成员 ID
+   * @param {string} linkId 链接 ID
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   */
+  async getLinkCustomerCnt(userId, linkId, startTime, endTime) {
+    return this.post('/externalcontact/acquisition/link/get_customer_cnt', {
+      user_id: userId,
+      link_id: linkId,
+      start_time: startTime,
+      end_time: endTime
+    });
+  }
+
+  /**
+   * 获取企业获客链接总收客数
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   */
+  async getCorpCustomerCnt(startTime, endTime) {
+    return this.post('/externalcontact/acquisition/get_customer_cnt', {
+      start_time: startTime,
+      end_time: endTime
+    });
+  }
+
+  /**
+   * 获取成员获客统计
+   * @param {string} userId 成员 ID
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   */
+  async getUserAcquisitionStat(userId, startTime, endTime) {
+    return this.post('/externalcontact/acquisition/user/stat', {
+      user_id: userId,
+      start_time: startTime,
+      end_time: endTime
+    });
+  }
+
+  /**
+   * 获取获客链接统计
+   * @param {string} linkId 链接 ID
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   */
+  async getLinkStat(linkId, startTime, endTime) {
+    return this.post('/externalcontact/acquisition/link/stat', {
+      link_id: linkId,
+      start_time: startTime,
+      end_time: endTime
+    });
+  }
+
+  // ========== 获客助手事件 ==========
+
+  /**
+   * 获取由获客链接添加的客户信息
+   * @param {string} linkId 链接 ID
+   * @param {string} userId 成员 ID
+   * @param {string} cursor 分页游标
+   */
+  async getLinkCustomers(linkId, userId, cursor = '') {
+    return this.post('/externalcontact/acquisition/link/get_customer', {
+      link_id: linkId,
+      user_id: userId,
+      cursor
+    });
+  }
+
+  // ========== 广告优化 ==========
+
+  /**
+   * 提升广告有效率
+   * @param {string} userId 成员 ID
+   * @param {string} externalUserId 外部客户 ID
+   */
+  async improveAdEffect(userId, externalUserId) {
+    return this.post('/externalcontact/acquisition/ad/improve', {
+      user_id: userId,
+      external_userid: externalUserId
+    });
+  }
+
+  /**
+   * 获取广告获客分析
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   * @param {string} userId 成员 ID（可选）
+   */
+  async getAdAnalysis(startTime, endTime, userId = '') {
+    return this.post('/externalcontact/acquisition/ad/analysis', {
+      start_time: startTime,
+      end_time: endTime,
+      user_id: userId
+    });
+  }
+
+  // ========== 成员收客详情 ==========
+
+  /**
+   * 获取成员多次收消息详情
+   * @param {string} userId 成员 ID
+   * @param {string} cursor 分页游标
+   * @param {number} size 每页数量
+   */
+  async getUserMultiReceiveStat(userId, cursor = '', size = 100) {
+    return this.post('/externalcontact/acquisition/user/get_multi_recv_stat', {
+      user_id: userId,
+      cursor,
+      limit: size
+    });
+  }
+}
+
+module.exports = OceanEngine;

package/src/modules/openchat/index.js

@@ -0,0 +1,197 @@
+/**
+ * 智能表格群聊模块
+ * API 章节：八 - 智能表格自动化创建的群聊
+ * 包含：获取群聊列表、群聊详情、修改群聊
+ */
+
+const WeComSDK = require('../../sdk');
+
+class OpenChat extends WeComSDK {
+  constructor(config) {
+    super(config);
+  }
+
+  // ========== 群聊管理 ==========
+
+  /**
+   * 获取群聊列表
+   * @param {string} cursor 分页游标
+   * @param {number} size 每页数量
+   */
+  async getChatList(cursor = '', size = 100) {
+    return this.post('/openchat/list', { cursor, limit: size });
+  }
+
+  /**
+   * 获取群聊详情
+   * @param {string} openChatId 群聊 ID
+   */
+  async getChatDetail(openChatId) {
+    return this.post('/openchat/get', { open_chatid: openChatId });
+  }
+
+  /**
+   * 修改群聊（智能表格）
+   * @param {string} openChatId 群聊 ID
+   * @param {string} name 群名称
+   * @param {string} owner 群主
+   * @param {string} ownerType 群主类型: userid, open_userid
+   */
+  async updateChat(openChatId, { name, owner, ownerType }) {
+    return this.post('/openchat/update', {
+      open_chatid: openChatId,
+      name,
+      owner,
+      owner_type: ownerType
+    });
+  }
+
+  /**
+   * 解散群聊
+   * @param {string} openChatId 群聊 ID
+   */
+  async dismissChat(openChatId) {
+    return this.post('/openchat/dismiss', { open_chatid: openChatId });
+  }
+
+  // ========== 群成员管理 ==========
+
+  /**
+   * 获取群成员列表
+   * @param {string} openChatId 群聊 ID
+   * @param {string} cursor 分页游标
+   * @param {number} size 每页数量
+   */
+  async getMemberList(openChatId, cursor = '', size = 100) {
+    return this.post('/openchat/member/list', {
+      open_chatid: openChatId,
+      cursor,
+      limit: size
+    });
+  }
+
+  /**
+   * 添加群成员
+   * @param {string} openChatId 群聊 ID
+   * @param {string[]} userIds 成员 ID 列表
+   */
+  async addMembers(openChatId, userIds) {
+    return this.post('/openchat/member/add', {
+      open_chatid: openChatId,
+      user_ids: userIds
+    });
+  }
+
+  /**
+   * 移除群成员
+   * @param {string} openChatId 群聊 ID
+   * @param {string[]} userIds 成员 ID 列表
+   */
+  async removeMembers(openChatId, userIds) {
+    return this.post('/openchat/member/del', {
+      open_chatid: openChatId,
+      user_ids: userIds
+    });
+  }
+
+  // ========== 群管理员管理 ==========
+
+  /**
+   * 设置群管理员
+   * @param {string} openChatId 群聊 ID
+   * @param {string} userId 成员 ID
+   */
+  async setAdmin(openChatId, userId) {
+    return this.post('/openchat/set_admin', {
+      open_chatid: openChatId,
+      userid: userId
+    });
+  }
+
+  /**
+   * 取消群管理员
+   * @param {string} openChatId 群聊 ID
+   * @param {string} userId 成员 ID
+   */
+  async removeAdmin(openChatId, userId) {
+    return this.post('/openchat/del_admin', {
+      open_chatid: openChatId,
+      userid: userId
+    });
+  }
+
+  // ========== 群公告管理 ==========
+
+  /**
+   * 设置群公告
+   * @param {string} openChatId 群聊 ID
+   * @param {string} content 公告内容
+   */
+  async setAnnouncement(openChatId, content) {
+    return this.post('/openchat/set_announcement', {
+      open_chatid: openChatId,
+      content
+    });
+  }
+
+  /**
+   * 获取群公告
+   * @param {string} openChatId 群聊 ID
+   */
+  async getAnnouncement(openChatId) {
+    return this.post('/openchat/get_announcement', { open_chatid: openChatId });
+  }
+
+  // ========== 群标签管理 ==========
+
+  /**
+   * 设置群标签
+   * @param {string} openChatId 群聊 ID
+   * @param {string[]} tagIds 标签 ID 列表
+   */
+  async setTags(openChatId, tagIds) {
+    return this.post('/openchat/set_tag', {
+      open_chatid: openChatId,
+      tag_ids: tagIds
+    });
+  }
+
+  /**
+   * 移除群标签
+   * @param {string} openChatId 群聊 ID
+   * @param {string[]} tagIds 标签 ID 列表
+   */
+  async removeTags(openChatId, tagIds) {
+    return this.post('/openchat/del_tag', {
+      open_chatid: openChatId,
+      tag_ids: tagIds
+    });
+  }
+
+  // ========== 群发消息 ==========
+
+  /**
+   * 发送消息到群聊
+   * @param {string} openChatId 群聊 ID
+   * @param {object} content 消息内容
+   * @param {string} msgType 消息类型
+   */
+  async sendMessage(openChatId, content, msgType = 'text') {
+    return this.post('/openchat/send', {
+      open_chatid: openChatId,
+      msgtype: msgType,
+      [msgType]: content
+    });
+  }
+
+  /**
+   * 发送模板卡片消息
+   * @param {string} openChatId 群聊 ID
+   * @param {object} cardData 卡片数据
+   */
+  async sendTemplateCard(openChatId, cardData) {
+    return this.sendMessage(openChatId, cardData, 'template_card');
+  }
+}
+
+module.exports = OpenChat;

package/src/modules/phone/index.js

@@ -0,0 +1,45 @@
+/**
+ * 公费电话模块
+ * API 章节：二十 - 公费电话
+ * 包含：拨打记录
+ */
+
+const WeComSDK = require('../../sdk');
+
+class Phone extends WeComSDK {
+  constructor(config) {
+    super(config);
+  }
+
+  /**
+   * 获取公费电话拨打记录
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   * @param {string} userId 成员 ID（可选）
+   * @param {number} offset 偏移量
+   * @param {number} size 每页数量
+   */
+  async getDialRecord(startTime, endTime, userId = '', offset = 0, size = 100) {
+    return this.post('/Dial/get_dial_record', {
+      start_time: startTime,
+      end_time: endTime,
+      userid: userId,
+      offset,
+      limit: size
+    });
+  }
+
+  /**
+   * 获取公费电话分钟数使用情况
+   * @param {number} startTime 开始时间戳
+   * @param {number} endTime 结束时间戳
+   */
+  async getUsageStat(startTime, endTime) {
+    return this.post('/Dial/get_usage_stat', {
+      start_time: startTime,
+      end_time: endTime
+    });
+  }
+}
+
+module.exports = Phone;