Skip to content

WShihan/webot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Repo stars GitHub forks GitHub repo size GitHub GitHub last commit GitHub package.json version (subfolder of monorepo)

1.介绍

小助手

一个基于wechaty的迷你机器人。

功能:

  • AI对话,可接入ChatGPT。
  • 可通过微信设置角色

2.安装

准备

  • Node > 14
  • 一个微信账号

1.克隆仓库

git clone https://github.com/WShihan/webot.git

2.修改配置

修改config目录下的data.js文件,填写如下配置项

{
  // 机器人密钥,参考3.3小节设置
  BOT_KEY: ''
  // chatgpt 接口
  GPT_URL: '',
  // chatgpt 接口密钥
  GPT_KEY: '',
  // chatgpt模型
  GPT_MODEL: 'gpt-3.5-turbo',
  // chatgpt 系统提示(角色)
  ROLE: '一个微信机器人,说话很温柔',
  // 好友申请自动通过口令
  FRIENDSHIP_PASS: '',
  // 自定义指令回调地址
  CMD_URL: '',
  // 敏感词汇
  BLOCK_WORDS: [],
  // 回调指令事件,参考3.3小节设置
  CALLBACKS: []
}

3.安装依赖

在终端进入项目目录,执行如下命令安装依赖

npm install

4.启动机器人

执行如下命令启动机器人后,终端会显示二维码,需要打开手机客户端扫码登入。
⚠️ 注意:一定记得要使用小号,因为存在封号风险。

npm start

image-20240416134131663

如果你没有机器可供部署,可以添加我已经部署好的助手体验(验证信息:github)。

image-20240416140029042

3.使用

1.对话

直接发送消息对话

image-20240423162407678

2.修改配置

对话配置

发送如下格式文字 ,

接口/模型/密钥/角色 值

示例:

修改角色

image-20240423162102474

修改对话设置

image-20240423163136612

3. 其他配置

3.1 好友申请口令

当好友申请验证信息和口令一致时,自动通过。

image-20240423163520087

3.2 敏感词过滤

可设置和移除敏感词汇,防止出现危害/不良言论。

添加或移除多个敏感词时,用中文逗号隔开。

image-20240423164142194

3.3.回调指令

拓展小助手功能,通过触发关键字请求指定接口返回数据。

目前不支持在微信内设置回调事件,请在小助手初始化配置如下选项,

{
  BOT_KEY: ''
  CALLBACKS: [
    { keyword: "##天气", "url": "" },
    { keyword: "##NBA", "url": "" }]
}

说明:

  • BOT_KEY: 机器人密钥,加密用,自行设置即可
  • Keyword: 触发关键字(开头匹配)
  • url: 回调地址

触发关键字后,小助手将向目标地址发起post请求,请求头包含一个X-Signature,它是一个哈希值,由BOT_KEY请求体通过HMAC-SHA256计算所得,回调地址后端可自行验证。

请求体json格式如下:

{
    'word': '文本内容'
}

说明:

  • Word:微信消息文本

后端返回格式如下:

{
  "code": 200,
  "status": true,
  "data": [
    {"type": 1,"content": "返回的文本内容"},
  ],
  "msg": null
}

示例

image-20240423210044638

image-20240423210232390

4.说明

  • 请准守微信使用条款及国家法律法规,切勿用于非法用途。
  • 代码仅供交流使用。