yviscool/wxwork

企业微信nodejs sdk

企业微信 Node API

目前只封装了基本的模块 有兴趣的同学可以一起加入并丰富其 API

各个子模块相关文档 请前往 github 各个项目中查看

目前已完成模块

应用管理模块

通讯录管理模块

• 部门管理模块

• 标签管理模块

• 成员管理模块

素材管理模块

消息推送模块

oa 管理模块

• 企业微信打卡应用模块

企业微信文档地址 点击前往

安装模块

import { Wecom } from "wecom";

快速开始

// 初始化企业微信对象
const wecom = new Wecom({
  corpId: process.env.CORPID,
  corpSecret: process.env.CORP_SECRET,
});
// 发送消息
wecom.request({
  url: "/message/send",
  method: "POST",
  // 发送消息的参数参照 [（官方文档）](https://work.weixin.qq.com/api/doc/90000/90135/90236) [（API 文档）]()
  data: {
    touser: "username",
    msgtype: "text",
    agentid: Number(process.env.TEST_AGENT_ID),
    text: {
      content: "test",
    },
  },
});

参数说明

下面的必要参数都是申请企业微信应用时分配给到的，需要和相关负责人说明需要

参数名	参数类型	必填	参数描述
corpId	string	是	企业微信 corpid
corpSecret	string	是	企业微信 corpsecret
baseURL	string	否	企业微信服务器地址 (默认:https://qyapi.weixin.qq.com/cgi-bin/)
retryTimes	number	否	认证失败的错误重试次数 其他错误信息不进行重试(默认:3)

静态方法

方法名：setGlobal 说明：添加全局配置信息

Wecom.setGlobal((config: Partial<WecomConfig>));

实例方法

方法名：getToken 说明: 获取发送需要用到的 token 信息

wecom.getToken();

方法名：request 说明：向企业微信发送相关的请求

wecom.request((config: AxiosRequestConfig));

方法名：createApi 说明：创建新的调用 api

wecom.createApi((path: string), fn);

项目构建

yarn run build

单元测试

请先创建.env文件，并将.env.example中的内容复制过去

相关的配置信息为作者创建的测试企业。如果有其他的需求，请通过issue提出

yarn run test

目录:

• 通讯录管理 （官方文档）（API 文档）
  • 成员管理 （官方文档）（API 文档）
    • 创建成员 （官方文档）（API 文档）
    • 读取成员 （官方文档）（API 文档）
    • 更新成员 （官方文档）（API 文档）
    • 删除成员 （官方文档）（API 文档）
    • 批量删除成员 （官方文档）（API 文档）
    • 获取部门成员 （官方文档）（API 文档）
    • 获取部门成员详情 （官方文档）（API 文档）
    • userid 与 openid 互换 （官方文档）（API 文档）
    • 二次验证 （官方文档）（API 文档）
    • 邀请成员 （官方文档）（API 文档）
    • 获取加入企业二维码 （官方文档）（API 文档）
    • 获取企业活跃成员数 （官方文档）（API 文档）
  • 部门管理 （官方文档）（API 文档）
    • 创建部门 （官方文档）（API 文档）
    • 更新部门 （官方文档）（API 文档）
    • 删除部门 （官方文档）（API 文档）
    • 获取部门列表 （官方文档）（API 文档）
  • 标签管理 （官方文档）（API 文档）
    • 创建标签 （官方文档）（API 文档）
    • 更新标签名字 （官方文档）（API 文档）
    • 删除标签 （官方文档）（API 文档）
    • 获取标签成员 （官方文档）（API 文档）
    • 增加标签成员 （官方文档）（API 文档）
    • 删除标签成员 （官方文档）（API 文档）
    • 获取标签列表 （官方文档）（API 文档）
  • 异步批量接口 （官方文档）（API 文档）
    • 增量更新成员 （官方文档）（API 文档）
    • 全量覆盖成员 （官方文档）（API 文档）
    • 全量覆盖部门 （官方文档）（API 文档）
    • 获取异步任务列表 （官方文档）（API 文档）
  • 通讯录回调通知 （官方文档）（API 文档）
    • 成员变更通知 （官方文档）（API 文档）
    • 部门变更通知 （官方文档）（API 文档）
    • 标签变更通知 （官方文档）（API 文档）
    • 异步任务完成通知 （官方文档）（API 文档）
• 外部联系人管理 （官方文档）（API 文档）
  • 成员对外信息 （官方文档） （API 文档）
  • 企业服务人员管理 （官方文档） （API 文档）
    • 获取配置了客户联系功能的成员列表 （官方文档） （API 文档）
    • 客户联系「联系我」管理 （官方文档） （API 文档）
  • 客户管理 （官方文档） （API 文档）
    • 获取客户列表 （官方文档） （API 文档）
    • 获取客户详情 （官方文档） （API 文档）
    • 批量获取客户详情 （官方文档） （API 文档）
    • 修改客户备注信息 （官方文档） （API 文档）
  • 客户标签管理 （官方文档） （API 文档）
    • 管理企业标签 （官方文档） （API 文档）
    • 编辑客户企业标签 （官方文档） （API 文档）
  • 客户群管理 （官方文档） （API 文档）
    • 获取客户群列表 （官方文档） （API 文档）
    • 获取客户群详情 （官方文档） （API 文档）
  • 消息推送 （官方文档） （API 文档）
    • 添加企业群发消息任务 （官方文档） （API 文档）
    • 获取企业群发消息发送结果 （官方文档） （API 文档）
    • 发送新客户欢迎语 （官方文档） （API 文档）
    • 群欢迎语素材管理 （官方文档） （API 文档）
  • 客户分配 （官方文档） （API 文档）
    • 分配成员的客户 （官方文档） （API 文档）
    • 获取离职成员的客户列表 （官方文档） （API 文档）
    • 查询客户接替结果 （官方文档） （API 文档）
    • 离职成员的群再分配 （官方文档） （API 文档）
  • 统计管理 （官方文档） （API 文档）
    • 获取联系客户统计数据 （官方文档） （API 文档）
    • 获取客户群统计数据 （官方文档） （API 文档）
• 应用管理 （官方文档） （API 文档）
  • 获取应用 （官方文档） （API 文档）
  • 设置应用 （官方文档） （API 文档）
  • 自定义菜单 （官方文档） （API 文档）
    • 创建菜单 （官方文档） （API 文档）
    • 获取菜单 （官方文档） （API 文档）
    • 删除菜单 （官方文档） （API 文档）
  • 设置工作台自定义展示 （官方文档） （API 文档）
• 消息推送 （官方文档） （API 文档）
  • 发送应用消息 （官方文档） （API 文档）
  • 更新任务卡片消息状态 （官方文档） （API 文档）
  • 发送消息到群聊会话 （官方文档） （API 文档）
    • 创建群聊会话 （官方文档） （API 文档）
    • 修改群聊会话 （官方文档） （API 文档）
    • 获取群聊会话 （官方文档） （API 文档）
    • 应用推送消息 （官方文档） （API 文档）
  • 互联企业消息推送 （官方文档） （API 文档）
    • 发送应用消息 （官方文档） （API 文档）
  • 查询应用消息发送统计 （官方文档） （API 文档）
• 素材管理 （官方文档） （API 文档）
  • 上传临时素材 （官方文档） （API 文档）
  • 上传图片 （官方文档） （API 文档）
  • 获取临时素材 （官方文档） （API 文档）
  • 获取高清语音素材 （官方文档） （API 文档）
• OA 数据接口 （官方文档） （API 文档）
  • 企业微信打卡应用 （官方文档） （API 文档）
    • 获取打卡数据 （官方文档） （API 文档）
    • 获取打卡规则 （官方文档） （API 文档）
  • 企业微信审批应用 （官方文档） （API 文档）
    • 获取审批模板详情 （官方文档） （API 文档）
    • 提交审批申请 （官方文档） （API 文档）
    • 批量获取审批单号 （官方文档） （API 文档）
    • 获取审批申请详情 （官方文档） （API 文档）
  • 企业微信公费电话 （官方文档） （API 文档）
    • 获取公费电话拨打记录 （官方文档） （API 文档）
  • 自建应用 （官方文档） （API 文档）
    • 审批流程引擎 （官方文档） （API 文档）
• 日程 （官方文档） （API 文档）
  • 日历 （官方文档） （API 文档）
    • 创建日历 （官方文档） （API 文档）
    • 更新日历 （官方文档） （API 文档）
    • 获取日历 （官方文档） （API 文档）
    • 删除日历 （官方文档） （API 文档）
  • 日程 （官方文档） （API 文档）
    • 创建日程 （官方文档） （API 文档）
    • 更新日程 （官方文档） （API 文档）
    • 获取日程 （官方文档） （API 文档）
    • 取消日程 （官方文档） （API 文档）
    • 获取日历下的日程列表 （官方文档） （API 文档）
• 微盘 （官方文档） （API 文档）
  • 空间管理 （官方文档） （API 文档）
    • 新建空间 （官方文档） （API 文档）
    • 重命名空间 （官方文档） （API 文档）
    • 解散空间 （官方文档） （API 文档）
    • 获取空间信息 （官方文档） （API 文档）
  • 空间权限 （官方文档） （API 文档）
    • 添加成员/部门 （官方文档） （API 文档）
    • 移除成员/部门 （官方文档） （API 文档）
    • 权限管理 （官方文档） （API 文档）
    • 获取邀请链接 （官方文档） （API 文档）
  • 文件管理 （官方文档） （API 文档）
    • 获取文件列表 （官方文档） （API 文档）
    • 上传文件 （官方文档） （API 文档）
    • 下载文件 （官方文档） （API 文档）
    • 新建文件 （官方文档） （API 文档）
    • 重命名文件 （官方文档） （API 文档）
    • 移动文件 （官方文档） （API 文档）
    • 删除文件 （官方文档） （API 文档）
    • 文件信息 （官方文档） （API 文档）
  • 文件权限 （官方文档） （API 文档）
    • 新增指定人 （官方文档） （API 文档）
    • 删除指定人 （官方文档） （API 文档）
    • 分享设置 （官方文档） （API 文档）
    • 获取分享链接 （官方文档） （API 文档）
• 会议室 （官方文档） （API 文档）
  • 会议室管理 （官方文档） （API 文档）
  • 会议室预定管理 （官方文档） （API 文档）
• 企业支付 （官方文档） （API 文档）
  • 企业红包 （官方文档） （API 文档）
    • 发送企业红包 （官方文档） （API 文档）
    • 查询红包记录 （官方文档） （API 文档）
  • 向员工付款 （官方文档） （API 文档）
    • 向员工付款 （官方文档） （API 文档）
    • 查询付款记录 （官方文档） （API 文档）
  • 向员工收款 （官方文档） （API 文档）
• 电子发票 （官方文档） （API 文档）
  • 查询电子发票 （官方文档） （API 文档）
  • 更新发票状态 （官方文档） （API 文档）
  • 批量更新发票状态 （官方文档） （API 文档）
  • 批量查询电子发票 （官方文档） （API 文档）
• 会话内容存档 （官方文档） （API 文档）
  • 获取会话内容 （官方文档） （API 文档）
  • 获取会话内容存档开启成员列表 （官方文档） （API 文档）
  • 获取会话同意情况 （官方文档） （API 文档）
  • 获取会话内容存档内部群消息 （官方文档） （API 文档）
• 企业直播 （官方文档） （API 文档）
  • 获取成员直播 ID 列表 （官方文档） （API 文档）
  • 获取直播详情 （官方文档） （API 文档）
  • 获取看直播统计 （官方文档） （API 文档）
• 健康上报 （官方文档） （API 文档）
  • 获取健康上报使用统计 （官方文档） （API 文档）
  • 获取健康上报任务 ID 列表 （官方文档） （API 文档）
  • 获取健康上报任务详情 （官方文档） （API 文档）
  • 获取用户填写答案 （官方文档） （API 文档）