egg-wxwork

Install

$ npm i egg-wxwork --save

Usage

// {app_root}/config/plugin.js
exports.wxwork = {
  enable: true,
  package: 'egg-wxwork',
};

Configuration

// {app_root}/config/config.default.js
exports.wxwork = {
    qwUrl: "", // 企微请求接口
  	corpId: "", // 企业id
  	corpSecret: "", // 应用密钥
  	directoryCorpSecret: "", // 通讯录同步密钥
  	userCorpSecret: "", // 客户联系密钥
  	callBackToken: "",//回调地址token
  	callBackEncodingAESKey: "",//回调地址encodingAESKey
};

see config/config.default.js for more detail.

目录

|--lib
	|--help
		|--axios.js 接口请求
		|--errorCode.js 企微错误码
		|--utils.js 工具方法
	|--service
		|--agent.js  应用
		|--auth.js   授权登录
		|--base.js   基础类
		|--department.js 部门
		|--extendCustomer.js 在职/离职继承
		|--externalContact.js 外部联系人
		|--externalContactMoment.js 客户朋友圈
		|--externalContactTag.js 客户标签
		|--groupChat.js 客户群
		|--index.js 入口文件
		|--media.js 素材
		|--message.js 应用消息
		|--tag.js 标签
		|--user.js 用户
	|--index.js 实例类

已实现功能

• [ ] 基础

  • [ ] 通讯录管理

    • [x] 成员管理
      • [x] 获取成员id列表
      • [x] 创建成员
      • [x] 读取成员
      • [x] 更新成员
      • [x] 删除成员
      • [x] 批量删除成员
      • [x] 获取部门成员
      • [x] 获取部门成员详情
      • [x] 邀请成员
      • [x] 获取加入企业二维码
      • [x] 手机号获取userid
      • [x] 邮箱获取userid
    • [x] 部门管理
      • [x] 创建部门
      • [x] 更新部门
      • [x] 删除部门
      • [x] 获取部门列表
      • [x] 获取子部门ID列表
    • [x] 标签管理
      • [x] 获取标签列表
      • [x] 创建标签
      • [ ] 更新标签名字
      • [x] 删除标签
      • [x] 获取标签成员
      • [x] 增加标签成员
      • [x] 删除标签成员
    • [ ] 通讯录回调通知
      • [x] 成员变更通知
      • [x] 部门变更通知
      • [x] 标签变更通知
      • [ ] 异步任务完成通知

  • [ ] 身份验证

    • [x] 网页授权登录
    • [ ] 扫码授权登录

  • [ ] 消息推送

    • [x] 发送应用消息
    • [x] 更新模版卡片消息
    • [x] 撤回应用消息
    • [x] 接收消息与事件
    • [ ] 发送消息到群聊会话

  • [ ] 应用管理

    • [x] 获取应用
    • [x] 设置应用
    • [x] 自定义菜单
    • [ ] 设置工作台自定义展示-回调

  • [ ] 素材管理

    • [x] 上传临时素材
    • [x] 上传图片
    • [x] 获取临时素材
    • [ ] 异步上传临时素材

• [ ] 连接微信

  • [x] 成员对外信息
  • [x] 获取配置了客户联系功能的成员列表
  • [x] 客户管理
    • [x] 获取客户列表
    • [x] 获取客户详情
    • [x] 批量获取客户详情
    • [x] 修改客户备注信息
    • [x] 客户联系规则组管理
  • [x] 客户标签管理
    • [x] 管理企业标签
    • [x] 管理企业规则组下的客户标签
    • [x] 编辑客户企业标签
  • [x] 在职继承
    • [x] 分配在职成员的客户
    • [x] 查询客户接替状态
    • [x] 分配在职成员的客户群
  • [x] 离职继承
    • [x] 获取待分配的离职成员列表
    • [x] 分配离职成员的客户
    • [x] 查询客户接替状态
    • [x] 分配离职成员的客户群
  • [x] 客户群管理
    • [x] 获取客户群列表
    • [x] 获取客户群详情
    • [ ] 客户群opengid转换
  • [x] 客户朋友圈
    • [x] 企业发表内容到客户的朋友圈
    • [x] 获取客户朋友圈全部的发表记录
    • [x] 客户朋友圈规则组管理
  • [x] 消息推送
    • [x] 创建企业群发
    • [x] 获取企业的全部群发记录
    • [x] 发送新客户欢迎语
    • [x] 入群欢迎语素材管理
  • [x] 统计管理
    • [x] 获取「联系客户统计」数据
    • [x] 获取「群聊数据统计」数据
  • [x] 回调通知
  • [x] 管理聊天敏感词
    • [x] 新建敏感词规则
    • [x] 获取敏感词规则列表
    • [x] 获取敏感词规则详情
    • [x] 修改敏感词规则
    • [x] 删除敏感词规则
  • [x] 上传附件资源