wecom
TypeScript icon, indicating that this package has built-in type declarations

0.8.3 • Public • Published

企业微信 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

目录:

Package Sidebar

Install

npm i wecom

Weekly Downloads

4

Version

0.8.3

License

MIT

Unpacked Size

108 kB

Total Files

60

Last publish

Collaborators

  • aiden