Discover danni-cool/wechatbot-webhook Open Source project

一个支持消息收发的微信 webhook 机器人，用 http 请求即可给微信发消息

📝 FAQ

💼 Feature

项目基于web协议，只做研究和学习使用，功能相对有限，以下是所有受支持的功能，请按需服用

功能	推送消息	接收消息
支持的功能	✅ 发送文字 ✅ 发送图片 ✅ 发送文件	✅ 文字 ✅ 链接卡片(公众号推文链接) ✅ 图片 ✅ 视频 ✅ 附件 ✅ 语音

🚀 启动

拉取镜像

docker pull dannicool/docker-wechatbot-webhook

启动容器

该方法会在后台启动一个 只能给微信推消息 的容器

docker run -d \
--name wxBotWebhook \
-p 3001:3001 \
dannicool/docker-wechatbot-webhook

可选参数

Tips：需要增加参数使用 -e，多行用 \ 隔开，例如 -e RECVD_MSG_API="https://example.com/your/url" \

功能	环境变量	案例	备注
收消息	RECVD_MSG_API	RECVD_MSG_API="https://example.com/your/url"	如果想自己处理收到消息的逻辑，比如根据消息联动，填上你的处理逻辑 url，该行可以省略
自定义登录 API token	LOGIN_API_TOKEN	LOGIN_API_TOKEN=abcdefg123	你也可以自定义一个自己的登录令牌，不配置的话，默认会生成一个

👨🏻‍💻 登录wx

1.以下只展示 docker 启动，本地调试可以直接在控制台找到链接

docker logs -f wxBotWebhook

2.找到二维码登录地址，图下 url 部分，浏览器访问，扫码登录wx

https://localhost:3001/login?token=YOUR_PERSONAL_TOKEN

🛠️ API

1. 推消息

Url：http://localhost:3001/webhook/msg
Methods: POST

Case1. 发文字或文件(外链)

ContentType: application/json
Body: 格式见下面表格

json 请求发送文件只支持外链

参数	说明	数据类型	默认值	可否为空	可选参数
to	消息接收方，传入`String` 默认是发给昵称（群名同理）, 传入`Object` 结构支持发给备注过的人，比如：`{alias: '备注名'}`，群名不支持备注名	`String` `Object`	-	Y	-
isRoom	是否发的群消息，这个参数决定了找人的时候找的是群还是人，因为昵称其实和群名相同在技术处理上	`Boolean`	`false`	Y	`true` `false`
type	消息类型，消息不支持自动拆分，请手动调多次。	`String`	-	N	`text` `fileUrl`
content	消息内容，如果希望发多个Url并解析，type 指定为 fileUrl 同时，content 里填 url 以英文逗号分隔	`String`	-	N	-

Example（curl）

Curl (发文字)

curl --location --request POST 'http://localhost:3001/webhook/msg' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "testUser",
    "type": "text",
    "content": "Hello World!",
}'

Curl（发文件，解析url）

curl --location --request POST 'http://localhost:3001/webhook/msg' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "testGroup",
    "type": "fileUrl",
    "content": "https://samplelib.com/lib/preview/mp3/sample-3s.mp3",
    "isRoom": true
}'

Case2. 读文件发送

ContentType: multipart/form-data
FormData: 格式见下面表格

参数	说明	数据类型	默认值	可否为空	可选值
to	消息接收方，传入`String` 默认是发给昵称（群名同理）, 传入 Json String 结构支持发给备注过的人，比如："{alias: '备注名'}"，群名不支持备注名称	`String`	-	N	-
isRoom	是否发的群消息，formData纯文本只能使用 `String` 类型，`1`代表是，`0`代表否，	`String`	`0`	Y	`1` `0`
content	文件，本地文件一次只能发一个，多个文件手动调用多次	`Binary`	-	N	-

Curl

curl --location --request POST 'http://localhost:3001/webhook/msg' \
--form 'to=testGroup' \
--form content=@"$HOME/demo.jpg" \
--form 'isRoom=1'

2. 收消息

收消息接口使用 form 表单传递参数

入参：

Methods: POST
ContentType: multipart/form-data
Form格式如下

formData	说明	数据类型	可选值	示例
type	支持的类型 ✅ 文字(text) ✅ 链接卡片(urlLink) ✅ 图片(file) ✅ 视频(file) ✅ 附件(file) ✅ 语音(file) close: #10 refer: wechaty类型支持列表	`String`	`text` `file` `urlLink`	-
content	传输的内容, 文本或传输的文件共用这个字段，结构映射请看示例	`String` `Binary`		示例
source	消息的相关发送方数据, JSON String	`String`		示例
isMentioned	该消息是@我的消息#38	`String`	`1` `0`	-
isSystemEvent	是否是来自系统消息事件（比如上线，掉线、异常事件）	`String`	`1` `0`	-

3. 登录APi

在异常或者掉线事件触发后，通知你配置的 RECVD_MSG_API，
在收到通知后，访问登录 Api 扫码登录 http://localhost:3001/login?token=YOUR_PERSONAL_TOKEN。

自定义token

token 初次启动项目会自动生成，你也可以配置一个简单好记的token，如果都配置，docker 配置将覆盖本地配置

docker 启动，参数为 -e LOGIN_API_TOKEN="YOUR_PERSONAL_TOKEN"
.env 文件中，配置 LOCAL_LOGIN_API_TOKEN=YOUR_PERSONAL_TOKEN

API 路径	Query Params	Methods	描述
/login	token	`GET`	登录成功，返回及当前用户。登录态掉了，跳转最新的登录二维码
/loginCheck	token	`GET`	获取登录状态 API，始终返回 json 格式，登录二维码在登录失败会放在 `message` 中

/loginCheck 返回体

JSON	说明	数据类型	可选值
success	登录成功与否	`Boolean`	`true` / `false`
message	当前登录用户名，登录失败将返回扫码登录URL	`String`

🌟 Star History

⏫ 更新日志

更新内容参见 CHANGELOG

danni-cool/wechatbot-webhook

danni-cool

Reviews

Repository Details