【免费下载】 WechatBot-Webhook 项目消息推送API详解

项目概述

WechatBot-Webhook 是一个基于微信机器人的消息推送服务，提供了标准化的API接口，允许开发者通过HTTP请求向微信个人或群组发送消息和文件。本文将详细介绍该项目的V1版本消息推送API的使用方法。

API基础信息

请求端点

POST http://localhost:3001/webhook/msg?token=[YOUR_PERSONAL_TOKEN]

认证方式

所有请求都需要在URL中携带个人令牌(token)作为身份验证。

消息发送方式

WechatBot-Webhook 提供了两种主要的消息发送方式：

1. JSON格式发送（支持文字和外部文件链接）

Content-Type: application/json

请求参数说明

参数名	说明	数据类型	必填	默认值	注意事项
to	消息接收方	String/Object	是	-	可传字符串(昵称)或对象(如{alias: '备注名'})
isRoom	是否为群消息	Boolean	否	false	true表示群消息，false表示个人消息
type	消息类型	String	是	text	可选值: text(文本), fileUrl(文件链接)
content	消息内容	String	是	-	文件链接时可用逗号分隔多个URL

使用示例

发送文本消息:

curl --location --request POST 'http://localhost:3001/webhook/msg?token=your_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "好友昵称",
    "type": "text",
    "content": "这是一条测试消息"
}'

发送文件链接:

curl --location --request POST 'http://localhost:3001/webhook/msg?token=your_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "群聊名称",
    "type": "fileUrl",
    "content": "https://example.com/file1.mp3,https://example.com/file2.jpg",
    "isRoom": true
}'

2. 表单格式发送（支持本地文件上传）

Content-Type: multipart/form-data

请求参数说明

参数名	说明	数据类型	必填	默认值	注意事项
to	消息接收方	String	是	-	仅支持昵称或群名称
isRoom	是否为群消息	String	否	"0"	"1"表示群消息，"0"表示个人消息
content	文件内容	Binary	是	-	一次只能上传一个文件

使用示例

curl --location --request POST 'http://localhost:3001/webhook/msg?token=your_token' \
--form 'to=群聊名称' \
--form content=@"/path/to/local/file.jpg" \
--form 'isRoom=1'

使用建议

1. 接收方标识：对于个人消息，建议使用备注名(alias)方式指定接收方，因为微信昵称可能重复或变更。

2. 大文件处理：对于大文件，建议先上传到云存储，然后使用文件链接方式发送。

3. 消息长度：文本消息不支持自动拆分，长消息需要开发者自行分段发送。

4. 错误处理：建议在客户端实现重试机制，处理可能的网络波动或服务暂时不可用情况。

5. 安全性：妥善保管个人令牌(token)，避免泄露导致未经授权的消息发送。

常见问题解答

Q: 为什么发送给群组时需要使用isRoom参数？ A: 因为个人昵称和群名称可能相同，需要通过isRoom参数明确指定消息接收方类型。

Q: 能否同时发送多个本地文件？ A: 目前API设计为一次请求只能发送一个本地文件，多个文件需要发起多次请求。

Q: 文件链接支持哪些协议？ A: 支持标准的HTTP/HTTPS协议，确保链接可公开访问且服务器响应正确的内容类型。

Q: 如何确认消息是否发送成功？ A: API会返回相应的状态码和响应体，200状态码通常表示发送成功。

通过本文的介绍，开发者应该能够熟练使用WechatBot-Webhook项目的消息推送API，实现微信消息的自动化发送功能。