Skip to content

coajs/coa-wx-work

Folders and files

NameName
Last commit message
Last commit date

Latest commit

426f310 · Nov 11, 2022

History

20 Commits
Jun 1, 2021
Nov 15, 2021
Aug 5, 2021
Jun 1, 2021
Sep 28, 2021
Mar 29, 2021
Jun 1, 2021
Sep 28, 2021
Mar 29, 2021
Sep 28, 2021
Sep 28, 2021
Jun 1, 2021
Nov 11, 2022

Repository files navigation

coa-wx-work

GitHub license npm version npm downloads PRs Welcome

简洁的企业微信 SDK for Node.js

特点

根据日常实际项目使用情况:

  • 覆盖了绝大多数使用场景
  • 统一了异步表现形式,全部返回 Promise
  • 内置类型引用,无需额外查看文档,开箱即用,IDE 友好

快速开始

安装

yarn add coa-wx-work

使用

import {
  WxWorkBin,
  WxWorkDepartmentService,
  WxWorkMemberService,
} from 'coa-wx-work'

// Bin实例,任何服务都必须依赖此实例
const bin = new WxWorkBin()

// 定义一个agent配置
const agent = {
  corpId: 'wwc2bf51eeeeeee825b1',
  agentId: '1000001',
  secret: 'J1jxD5X3eXXXXXXXXXXXXIAHvawDRU4',
}

// 成员类服务实例
const memberService = new WxWorkMemberService(bin, agent)

// 获取成员列表
await memberService.getList()
// 创建成员
await memberService.create({ userid: 'u0001', name: 'AAA' })
// 更新成员
await memberService.update('u0001', { name: 'AAAAA' })
// 删除成员
await memberService.delete(['u0001'])

// 部门类服务实例
const departmentService = new WxWorkDepartmentService(bin, agent)

// 获取部门列表
await departmentService.getList()
// 创建部门
await departmentService.create({ id: 1, name: 'DeptA' })
// 更新部门
await departmentService.update(1, { name: 'DeptAA' })
// 删除部门
await departmentService.delete(1)

企业微信机器人的使用

import { WxWorkBin, WxWorkBotService, WxWorkMarkdown } from 'coa-wx-work'

// Bin实例,任何服务都必须依赖此实例
const bin = new WxWorkBin()

// 根据key创建一个bot服务
const botService = new WxWorkBotService(bin, 'XXXXX-XXXXX-XXXXX-XXXXX')

// 发送文本消息
await botService.text('文本消息')

// 通过base64方式发送图片消息
await botService.image('data of base64')

// 发送markdown消息
const content = new WxWorkMarkdown().header3('主题').text('主体内容')
await botService.markdown(content)