wechat-assistant-pro: A JavaScript repository from dizhu

智能微秘书

智能机器人配置管理平台，一键接入ChatGPT对话，无缝适配Dify和FastGPT知识库！

支持群组，个人定义不同的角色，灵活配置各种对话模式，绘图，识图，联网查询，GPTs，语音分析，技能丰富多样！拥有各种定时任务，Rss订阅，倒计时提醒，新闻咨询发送，批量群发，转发，跨群聊天，提醒功能，Api发送消息

配合智能微秘书客户端可以一键接入公众号，个人微信号，企业微信，Gitter，Lark，WhatsApp，5G消息等Wechaty所支持的协议

微秘书官网

本项目是搭配智能微秘书平台使用的微秘书客户端，想要使用自己的机器人，必须自己部署微秘书客户端方可。

依赖

node 版本 >18

项目说明

本项目是基于wechaty 的开源智能机器人项目，更多关于Wechaty项目说明及 api 文档可以移步：wechaty 介绍

微秘书部署详细教程链接地址：微秘书文档

提前准备

注册智能微秘书管理账号

注册：智能微秘书
初始化配置文件小助手配置->基础配置，修改后保存
个人中心获取APIKEY和APISECRET，后续配置用到

注册天行数据账号

由于本项目大部分定时资讯和一些天气接口来自于天行数据，所以需要提前准备好天行数据的账号，同时申请好相关接口的权限

1、注册: 天行数据

2、申请接口权限

必选接口

天行机器人: https://www.tianapi.com/apiview/47
天气:https://www.tianapi.com/apiview/72
新闻 : https://www.tianapi.com/apiview/51 ** (新闻资讯只需要申请这个接口即可，不需要申请具体的分类接口，务必记着)**
垃圾分类: https://www.tianapi.com/apiview/97

可选接口（如果想使用相应的功能还是必须申请的），但是如果默认使用了天行机器人，以下功能接口无需申请也可以，机器人会直接返回对应信息

目前平台只适配了以上天行数据的接口，其他接口暂未适配，如有需要，可以联系定制

开始

源码运行

需要node版本>16，如果是windows 系统，请使用win10及以上版本

Step 1: 安装

克隆本项目，并进入项目根目录执行 npm install安装项目依赖

Step 2: 配置

src/index.js代码中配置APIKEY和APISECRET

Step 3: 运行

执行命令npm run start，终端会显示二维码，可以直接扫码，也可以到智能微秘书（小助手配置->登录状态中进行扫码登录）

Step 4: 配置相应功能

在智能微秘书中配置你需要的功能后，给启动的微信发送更新关键词即可拉取最新配置（或者你自己设置的更新关键词，初始关键词是更新，** 每次修改配置后，请记得一定发送关键词更新配置**

Docker部署

由于自己构建部分依赖安装比较慢，或者经常会卡住，所以本项目已经提前构建好发布到dockerhub了，直接pull就行了

注：使用第三方镜像源加速的。拉取的可能不是最新版本，所以会运行不起来，建议使用官方镜像源，自行切换，不会的可以百度一下

可以在https://hub.docker.com/r/aibotk/wechat-assistant/tags 这里查看到最新的 tag版本

拉取完毕的大小大概不到 500M ,如果你拉取的大小超过 1G，大概率是拉取错版本了，请切换成官方源拉取

step1：拉取镜像

docker pull aibotk/wechat-assistant

step2：启动docker

docker run -d -e AIBOTK_KEY="微秘书apikey" -e AIBOTK_SECRET="微秘书apiSecret" --name=wechatbot aibotk/wechat-assistant

查看docker日志

docker logs  wechatbot

自行构建docker镜像

需要提前安装 docker 环境，项目根目录执行一下命令

docker build -t wechat-assistant .
#web协议
docker run -e AIBOTK_KEY="微秘书apikey" -e AIBOTK_SECRET="微秘书apiSecret" wechat-assistant

其他步骤同上

使用Gitpod 在线运行测试

现智能微秘书已经适配Gitpod，如果你想测试自己的账号是否能够正常登录，可以在线运行一下测试，此环境仅做测试，不建议作为生产环境使用。

Gitpod 是一个在线和开源平台，用于自动化和现成代码的开发环境。您可以点击下面的按钮在gitpod 上访问wechat-assistant-pro的完整设置。如果您以前从未使用过 gitpod，则需要使用您的 gitHub 帐户登录。

更多关于Gitpod的信息可以参考: https://wechaty.js.org/2021/02/06/wechaty-getting-started-without-leave-your-browser/

Railway部署

环境变量：AIBOTK_KEY和AIBOTK_SECRET必填

ipad协议运行

如果你有ipad的token，可以执行以下命令

docker run -d -e PAD_LOCAL_TOKEN="你申请的ipadlocal token" -e AIBOTK_KEY="微秘书apikey" -e AIBOTK_SECRET="微秘书apiSecret" --name=wechatbot aibotk/wechat-assistant

企微协议运行

如果你有企微的token，可以执行以下命令

docker run -d -e WORK_PRO_TOKEN="你申请的企微 token" -e AIBOTK_KEY="微秘书apikey" -e AIBOTK_SECRET="微秘书apiSecret" --name=wechatbot aibotk/wechat-assistant

windows协议

参考：[engine协议部署](https://help.aibotk.com/?plugin=czw_emDoc&post=8)

项目根目录执行命令：npm run engine

公众号部署

公众号部署目前仅只支持源码部署配置

修改文件src/office.js文件变量

import {WechatyBuilder} from 'wechaty'
import {WechatyWebPanelPlugin} from 'wechaty-web-panel'
import {PuppetOA} from 'wechaty-puppet-official-account'
const name = 'office-assistant-pro';
let bot = '';
const oa = new PuppetOA({
    appId           : '公众号appid',
    appSecret       : '公众号appSecret',
    token           : '公众号加密token',
    // personalMode: true, // 如果你是个人订阅号或者未认证 请开启此项
    // port 和 webhookProxyUrl 自己选择一个
    // port: 8077, // 有自己域名或者服务器 可以启用这个 服务启动的端口 自己映射好配到公众号后台机就行
    webhookProxyUrl: 'https://****.loca.lt'  // 如果没有自己的域名可以直接用默认自带穿透代理服务localtunnel ***替换成随机字符串即可  这个域名记得配置到公众号后台
})


bot = WechatyBuilder.build({
    name, // generate xxxx.memory-card.json and save login data for the next login
    puppet: oa,
});


bot
    .use(
        WechatyWebPanelPlugin({
            apiKey: '****',
            apiSecret: '****'
        }
    ))
bot.start()
    .catch((e) => console.error(e));

执行命令：npm run office

体验与交流

扫描下方二维码，添加智能微秘书，体验以上所有功能，发送加群关键词即可进入交流群，如果微信无法添加可以先进QQ群：1045575073

更新日志

常见问题处理

参见http://wechat.aibotk.com/docs/question

面板预览

功能预览

个人定时与群定时任务

跨群聊天

免责声明

本软件依据github上开源项目 Wechaty

通过简单的设置UI和交互，运行IM机器人。

请遵守国家法律政策，请勿用于非法犯罪行为！

请合理使用，一切不良行为和后果均与作者无关！

本项目不参与解析任何底层代码，只是适配层，所有底层协议均为第三方提供，与本人无关！

dizhu/wechat-assistant-pro

智能微秘书

依赖

项目说明

更多功能说明

提前准备

注册智能微秘书管理账号

注册天行数据账号

开始

源码运行

Step 1: 安装

Step 2: 配置

Step 3: 运行

Step 4: 配置相应功能

Docker部署

step1：拉取镜像

step2：启动docker

自行构建docker镜像

使用Gitpod 在线运行测试

Railway部署

ipad协议运行

企微协议运行

windows协议

公众号部署

体验与交流

更新日志

常见问题处理

面板预览

功能预览

免责声明

dizhu/wechat-assistant-pro

智能微秘书

依赖

项目说明

更多功能说明

提前准备

注册智能微秘书管理账号

注册天行数据账号

开始

源码运行

Step 1: 安装

Step 2: 配置

Step 3: 运行

Step 4: 配置相应功能

Docker部署

step1： 拉取镜像

step2： 启动docker

自行构建docker镜像

使用Gitpod 在线运行测试

Railway部署

ipad协议运行

企微协议运行

windows协议

公众号部署

体验与交流

更新日志

常见问题处理

面板预览

功能预览

免责声明

step1：拉取镜像

step2：启动docker