0.0.4 • Published 1 year ago

egg-wxwork v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

egg-wxwork

NPM version build status Test coverage David deps Known Vulnerabilities npm download

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 实例类

已实现功能

  • 基础

    • 通讯录管理

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

      • 网页授权登录
      • 扫码授权登录
    • 消息推送

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

      • 获取应用
      • 设置应用
      • 自定义菜单
      • 设置工作台自定义展示-回调
    • 素材管理

      • 上传临时素材
      • 上传图片
      • 获取临时素材
      • 异步上传临时素材
  • 连接微信

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