PushPlus MCP Server
OfficialThis server lets AI assistants send push notifications via pushplus to multiple channels and manage the full pushplus account through MCP tools.
Send messages: Send text, HTML, Markdown, JSON, and custom-template messages to WeChat, email, SMS, webhook, enterprise WeChat, QQ bot, ClawBot, CMCC, app, voice, and browser extension channels.
Batch sending: Send one message to multiple channels simultaneously via
/batchSend.Rich push options: Use titles, icons, topics, friend tokens, callback URLs, timestamps, preprocessing codes, and required
pushIdfor form/doc/excel/webdiff templates.Account & user management: View personal info, token, send counts, limit status, and manage message tokens.
Message management: List messages, query delivery results by shortCode, and delete messages.
Topic/group management: Create, edit, delete, exit, get QR codes, list subscribers, manage blacklists, and control group visibility.
Friend management: List friends, get personal QR codes, edit remarks, delete friends, and manage friend blacklists.
Webhook management: Add, edit, list, view, and delete webhook configurations across many provider types.
Settings management: Configure default channels per token, toggle send/receive limits, message open type, and extension forwarding.
Preprocessing rules: Add, edit, delete, list, and test pre-processing code (member feature).
Forward rules & logs: Create, modify, enable/disable, test, and inspect message forwarding rules plus trigger logs.
Channel management: View mail, WeChat MP, and enterprise WeChat app channel details.
ClawBot/CMCC/QQ bot management: Bind/unbind, get QR codes, check status, list QQ groups/configs, and send test messages.
Image/file upload: Get upload tokens, upload images via API, list and delete uploaded images.
Payments: Transfer points (high-risk withdrawal).
Server resources: Check server status, supported templates, and supported channels via MCP resources.
CLI & configuration: Test configuration, view config, and run the MCP server with environment variable support.
Allows sending push notifications to WeChat via PushPlus, supporting text, HTML, Markdown, and JSON message formats, with options for specific channels, groups, and recipients.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@PushPlus MCP Server send a test notification to my WeChat"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
pushplus mcp server
一个基于 Model Context Protocol (MCP) 的 pushplus 推送服务器,让 AI 助手能够通过 pushplus 发送推送消息到微信、邮箱等渠道。
🎉 现已发布到 NPM!
可直接通过npm install -g @perk-net/pushplus-mcp-server安装使用,无需下载源码。
📋 目录
Related MCP server: MCP-Pushover Bridge
功能特性
🚀 完整的 MCP 支持: 实现 Model Context Protocol 规范
📱 多渠道推送: 支持微信、QQ机器人、邮箱、短信、企业微信等多种推送渠道
🎨 多种消息格式: 支持 HTML、Markdown、纯文本、JSON 等格式
🔧 灵活配置: 支持环境变量配置,便于部署
🛡️ 类型安全: 使用 TypeScript 开发,提供完整的类型支持
📊 状态监控: 提供服务器状态和配置信息查询
🧪 测试友好: 内置配置测试和消息发送测试
🚀 快速开始
方式一:从 NPM 安装(推荐)
npm install -g @perk-net/pushplus-mcp-server安装完成后,pushplus-mcp 命令将全局可用。
优势:
✅ 安装简单,一条命令搞定
✅ 自动处理依赖关系
✅ 支持全局命令行工具
✅ 无需下载源码
方式二:从源码构建
如果您需要修改代码或进行开发:
# 克隆项目
git clone https://github.com/pushplus/pushplus-MCP-Server-TypeScript.git
cd pushplus-MCP-Server-TypeScript
# 安装依赖
npm install
# 构建项目
npm run build
# 测试配置
npm run test适用场景:
🛠️ 需要自定义功能
🔧 参与项目开发
📊 需要调试详细日志
获取 pushplus token
访问 pushplus 官网
微信扫码登录
在个人中心获取您的 Token
测试配置
# 设置环境变量
export PUSHPLUS_TOKEN=your_pushplus_token_here
# 测试配置
pushplus-mcp --test如果配置正确,您会收到一条测试推送消息!
集成到 Claude Desktop
打开 Claude Desktop 设置 → Developer → Edit Config
添加配置(根据您的操作系统选择):
NPM 安装用户 - Windows:
{
"mcpServers": {
"pushplus": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"@perk-net/pushplus-mcp-server"
],
"env": {
"PUSHPLUS_TOKEN": "您的Token",
"PUSHPLUS_SECRET_KEY": "您的SecretKey"
}
}
}
}NPM 安装用户 - Mac/Linux:
{
"mcpServers": {
"pushplus": {
"command": "npx",
"args": [
"-y",
"@perk-net/pushplus-mcp-server"
],
"env": {
"PUSHPLUS_TOKEN": "您的Token",
"PUSHPLUS_SECRET_KEY": "您的SecretKey"
}
}
}
}源码构建用户:
{
"mcpServers": {
"pushplus": {
"command": "node",
"args": ["/path/to/pushplus-mcp-server/dist/index.js"],
"env": {
"PUSHPLUS_TOKEN": "您的Token",
"PUSHPLUS_SECRET_KEY": "您的SecretKey"
}
}
}
}配置文件位置:
Windows:
%APPDATA%\Claude\claude_desktop_config.jsonmacOS:
~/Library/Application Support/Claude/claude_desktop_config.json
重启 Claude Desktop
开始使用!
在 Claude 中说:
"请发送一条测试推送消息到我的微信"🎉 恭喜!您已成功设置 pushplus mcp server!
📝 配置说明:当您在 Claude Desktop 配置中设置了
env.PUSHPLUS_TOKEN后,就不需要创建.env文件了。MCP 服务器会自动读取通过 Claude Desktop 传递的环境变量。
📱 功能使用
可用工具
1. send_push_message - 发送推送消息
完整的推送消息工具,对齐最新 /send 接口:
{
"content": "消息内容(必填)",
"title": "消息标题(可选)",
"icon": "消息图标(可选)",
"template": "html",
"channel": "wechat",
"topic": "群组编码(可选)",
"to": "好友令牌(可选)",
"pre": "预处理编码(可选,仅供会员使用)",
"webhook": "webhook编码(可选,非URL)",
"option": "渠道配置参数(可选,与webhook等价)",
"callbackUrl": "回调地址(可选)",
"timestamp": "1632993318000",
"pushId": "form/doc/excel/webdiff 模板必填"
}2. send_text_message - 发送文本消息
快速发送纯文本消息:
{
"content": "纯文本内容",
"title": "消息标题(可选)",
"topic": "群组编码(可选)",
"to": "好友令牌(可选)",
"pre": "预处理编码(可选)",
"channel": "wechat"
}3. send_html_message - 发送HTML消息
发送带有 HTML 格式的消息:
{
"content": "<h1>HTML内容</h1><p>支持HTML标签</p>",
"title": "消息标题(可选)",
"topic": "群组编码(可选)",
"to": "好友令牌(可选)",
"pre": "预处理编码(可选)",
"channel": "wechat"
}4. send_markdown_message - 发送Markdown消息
发送 Markdown 格式的消息:
{
"content": "# Markdown标题\n\n支持**粗体**和*斜体*",
"title": "消息标题(可选)",
"topic": "群组编码(可选)",
"to": "好友令牌(可选)",
"pre": "预处理编码(可选)",
"channel": "wechat"
}5. send_json_message - 发送JSON消息
发送 JSON 格式的消息:
{
"content": "{\"data\": \"JSON格式内容\"}",
"title": "消息标题(可选)",
"topic": "群组编码(可选)",
"to": "好友令牌(可选)",
"pre": "预处理编码(可选)",
"channel": "wechat"
}6. batch_send_message - 多渠道批量发送
对应 /batchSend 接口,可同时向多个渠道发送:
{
"content": "消息内容",
"channel": "wechat,mail,webhook",
"option": ",,webhook编码",
"title": "消息标题(可选)",
"template": "html",
"pushId": "form/doc/excel/webdiff 模板必填"
}7. 开放接口工具(open_*)
配置 PUSHPLUS_TOKEN + PUSHPLUS_SECRET_KEY 后可用,覆盖全部 /open/** 接口,命名规则:open_<模块>_<动作>。PUSHPLUS_TOKEN 与发送消息使用同一 token。
模块 | 示例工具 |
auth |
|
user |
|
message |
|
token |
|
topic |
|
topicUser |
|
friend |
|
webhook |
|
setting |
|
pre |
|
forwardRule |
|
forwardLog |
|
channel |
|
clawBot |
|
cmcc |
|
qqBot |
|
file/image |
|
pay |
|
说明:
开放接口实际地址形如
https://www.pushplus.plus/api/open/...;发送接口仍为/sendMCP 会自动换取并缓存
access-key(提前约 60 秒刷新)PUSHPLUS_TOKEN须为用户 token(开放接口不支持消息 token)使用前需在官网开启开放接口并配置安全 IP
各
open_*工具请求/响应字段说明对齐官方文档:https://www.pushplus.plus/doc/guide/openApi.html删除/提现/解绑等工具 description 中标注「高风险」
可用资源
1. pushplus://status - 服务器状态
获取服务器运行状态和配置信息
2. pushplus://templates - 支持的模板
获取所有支持的消息模板类型
3. pushplus://channels - 支持的渠道
获取所有支持的推送渠道信息
支持的消息模板
模板类型 | 描述 | 备注 |
| HTML格式消息 | 默认模板 |
| 纯文本消息 | |
| JSON格式消息 | |
| Markdown格式消息 | |
| 阿里云监控报警定制模板 | |
| Jenkins插件定制模板 | |
| 路由器插件定制模板 | |
| 支付成功通知模板 | |
| 订单支付成功模板 | |
| 实名认证模板 | |
| 表单格式模板 | 需传 |
| 文档格式模板 | 需传 |
| 表格格式模板 | 需传 |
| 网页差异对比模板 | 需传 |
支持的推送渠道
渠道类型 | 描述 | 备注 |
| 微信公众号推送 | 默认渠道 |
| 第三方webhook推送 | 传 webhook/option 编码(非URL) |
| 企业微信应用推送 | 需要配置企业微信应用 |
| 邮箱推送 | 需要绑定邮箱 |
| 短信推送 | 需要绑定手机号 |
| 语音推送 | 需要绑定手机号 |
| 浏览器插件推送 | |
| App推送 | 需要先登录App |
| 微信ClawBot推送 | 需要配置ClawBot |
| 新消息ClawBot推送 | 仅支持中国移动;需先绑定 Channel API Key;不填 |
| QQ机器人推送 | 需先绑定(支持官方机器人和自有机器人);不填 |
🛠️ 命令行工具
NPM 安装用户
# 显示帮助信息
pushplus-mcp --help
# 显示版本信息
pushplus-mcp --version
# 测试配置(包含发送测试消息)
pushplus-mcp --test
# 显示当前配置
pushplus-mcp --config
# 启动服务器(默认命令)
pushplus-mcp源码构建用户
# 显示帮助信息
node dist/index.js --help
# 显示版本信息
node dist/index.js --version
# 测试配置(包含发送测试消息)
npm run test
# 显示当前配置
node dist/index.js --config
# 启动服务器(默认命令)
npm start
# 开发模式
npm run dev
# 监听模式构建
npm run watch环境变量
变量名 | 描述 | 默认值 | 必需 |
| 用户 Token(发送与开放接口共用) | - | ✅ |
| 开放接口 secretKey | - | 调用 open_* 时需要 |
| API 根地址 | ❌ | |
| 开放接口前缀(发送不走此前缀) | /api | ❌ |
| MCP 服务器名称 | pushplus-mcp-server | ❌ |
| MCP 服务器版本 | 1.1.0 | ❌ |
| 默认消息模板 | html | ❌ |
| 默认推送渠道 | ❌ | |
| 调试模式 | false | ❌ |
📖 使用示例
1. 基本文本推送
在 Claude 中询问:
请使用 pushplus 发送一条测试消息,标题是"测试消息",内容是"这是一条来自 Claude 的测试消息"Claude 会调用 send_text_message 工具发送纯文本消息。
2. HTML 格式推送
请发送一条 HTML 格式的消息,标题"系统通知",内容包含:
- 一个标题
- 一个列表
- 一些样式Claude 会调用 send_html_message 工具发送带样式的消息。
3. Markdown 格式推送
请发送一条 Markdown 格式的消息,包含代码块和表格Claude 会调用 send_markdown_message 工具发送 Markdown 格式的消息。
4. JSON 格式推送
请发送一条 JSON 格式的消息,标题"API响应",内容为用户数据的JSON格式Claude 会调用 send_json_message 工具发送 JSON 格式的消息,适合发送结构化数据。
5. 自定义参数推送
请使用完整参数发送推送消息:
- 标题:重要通知
- 内容:HTML 格式的内容
- 推送渠道:微信
- 群组:开发团队
- 好友令牌:指定接收人Claude 会调用 send_push_message 工具,使用所有可用参数。
6. 好友推送
请发送消息给特定好友,使用好友令牌:token1,token2使用 to 参数可以指定具体的接收人,支持多人推送(逗号分隔)。
7. 理解响应结果
⚠️ 重要说明:HTTP 请求成功(状态码 200)并不代表消息发送成功,只是表示请求已被服务器接收处理。
响应结果解释
当您发送消息后,会收到如下格式的响应:
{
"code": 200,
"msg": "请求成功",
"data": "abc123def456"
}字段说明:
code: HTTP 响应状态码200: 请求成功被服务器接收其他值: 请求失败,需检查参数或配置
msg: 服务器返回的消息说明data: 📋 流水号(重要!)- 这是消息的唯一标识符,可用于后续查询消息发送状态count: 消息发送数量
📌 注意事项:
收到
code: 200只表示服务器接受了推送请求实际的消息发送可能需要一些时间完成
如需确认消息是否真正送达,请保存返回的
data(流水号)用于后续状态查询
8. 查询服务器状态
询问 Claude:
请查看 pushplus mcp server 的状态信息Claude 会读取 pushplus://status 资源,显示服务器状态。
9. 查看支持的功能
询问 Claude:
pushplus 支持哪些消息模板?Claude 会读取 pushplus://templates 资源,显示所有支持的模板类型。
询问 Claude:
pushplus 支持哪些推送渠道?Claude 会读取 pushplus://channels 资源,显示所有支持的推送渠道。
🔍 故障排除
常见问题
1. Token 无效
❌ 配置验证失败: PUSHPLUS_TOKEN 格式不正确,应为32位字符串解决方案:
检查您的 pushplus token 是否正确,Token 应该是32位的字母数字组合
确认 Token 是否有效且有足够的推送额度
2. 推送失败
❌ 发送失败: HTTP请求失败: 400 Bad Request解决方案:
检查消息内容是否符合格式要求
确认 Token 有效且有足够的推送额度
检查网络连接
确认消息标题不超过100字符
3. 理解响应状态
✅ HTTP请求成功
📊 响应详情:
- 状态码: 200
- 消息: 请求成功
- 📋 流水号: abc123def456 (重要!可用于查询消息发送状态)
- 计数: 1
⚠️ 注意:HTTP请求成功不代表消息已送达,实际发送可能需要一些时间。说明:
状态码 200表示服务器成功接收了推送请求流水号是消息的唯一标识符,请妥善保存用于后续查询消息实际送达可能需要几秒到几分钟的时间
如需确认消息是否真正送达,可使用流水号查询消息状态
4. 配置文件问题
❌ 配置验证失败: 缺少 PUSHPLUS_TOKEN 环境变量解决方案:
确保
.env文件存在并包含正确的配置或者通过环境变量直接设置
PUSHPLUS_TOKEN(如 Claude Desktop 配置)检查环境变量是否正确传递到 MCP 服务器
5. MCP 连接失败
解决方案:
确认 Claude Desktop 配置正确
检查命令和参数是否正确
重启 Claude Desktop
确认 NPM 包已正确安装
6. NPM 包无法找到
解决方案:
# 重新安装
npm uninstall -g @perk-net/pushplus-mcp-server
npm install -g @perk-net/pushplus-mcp-server
# 验证安装
pushplus-mcp --version👨💻 开发
项目结构
pushplus-mcp-server/
├── src/
│ ├── index.ts # 程序入口
│ ├── server.ts # MCP 服务器实现
│ ├── pushplus.ts # pushplus API 客户端
│ └── config.ts # 配置管理
├── dist/ # 编译输出目录
├── package.json # 项目配置
├── tsconfig.json # TypeScript 配置
└── README.md # 项目文档开发脚本
# 构建项目
npm run build
# 监听模式构建
npm run watch
# 清理构建文件
npm run clean
# 重新构建
npm run rebuild
# 开发模式(构建并启动)
npm run devTypeScript 支持
项目使用 TypeScript 开发,提供完整的类型支持:
严格类型检查: 启用 TypeScript 严格模式
Zod 验证: 使用 Zod 进行运行时类型验证
完整类型定义: 所有 API 和配置都有完整的类型定义
贡献指南
Fork 项目
创建功能分支
提交更改
推送到分支
创建 Pull Request
许可证
MIT License - 详见 LICENSE 文件
相关链接
🎉 享受使用 pushplus mcp server!
如有问题,欢迎提交 Issue 或 Pull Request
Available Tools
107 toolsbatch_send_message多渠道批量发送消息A
通过 pushplus /batchSend 接口同时向多个渠道发送消息。channel 用逗号隔开(最多5个),option 与 channel 一一对应。form/doc/excel/webdiff 模板必须传 pushId。
Inputs: content (required), to, pre, icon, +8 more.
open_clawbot_bot_infoClawBot 绑定详情A
GET /open/clawBot/botInfo - 获取已绑定机器人详情。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: createTime(绑定时间), haveContextToken(是否有对话令牌)。
Inputs: no named parameters.
open_clawbot_get_bot_qrcodeClawBot 绑定二维码A
GET /open/clawBot/getBotQrcode - 获取微信 ClawBot 绑定二维码。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: url(二维码地址), qrcode(二维码编号,用于查询扫码状态)。
Inputs: no named parameters.
open_clawbot_get_msgClawBot 获取发送消息A
GET /open/clawBot/getMsg - 获取 ClawBot 侧消息(可能耗时较长)。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 数组,项含 type(1文字/3语音), text(消息内容)。
Inputs: no named parameters.
open_clawbot_get_qrcode_statusClawBot 扫码结果查询A
GET /open/clawBot/getQrcodeStatus - 查询扫码绑定状态。 请求(url): qrcode(二维码编号,必填;来自 getBotQrcode 的 data.qrcode)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: qrcode (required).
open_clawbot_unbind解绑 ClawBotA
GET /open/clawBot/unbind - 高风险:解绑微信 ClawBot。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: no named parameters.
open_cmcc_bind绑定新消息ClawBotA
POST /open/cmcc/bind - 绑定新消息ClawBot。 请求(body): apiKey(必填;中国移动新消息 Channel API Key,必须以 ak_ 或 app_ 开头)。 需先在手机 5G 消息「新消息ClawBot」应用号中获取 API Key。仅支持中国移动用户。 绑定成功后可用 /send 且 channel=cmcc,无需 option。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: apiKey (required).
open_cmcc_info查询新消息ClawBot绑定状态A
GET /open/cmcc/info - 查询新消息ClawBot绑定状态。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: bound(0未绑定/1已绑定), apiKeyMasked(脱敏后的API Key), createTime(绑定时间)。
Inputs: no named parameters.
open_cmcc_test发送新消息ClawBot测试消息A
GET /open/cmcc/test - 发送新消息ClawBot测试消息。 请求参数: 无。未绑定会返回「未绑定新消息ClawBot」。 测试成功后请到手机 5G 消息应用号中查看。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: no named parameters.
open_cmcc_unbind解绑新消息ClawBotB
GET /open/cmcc/unbind - 高风险:解绑新消息ClawBot。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: no named parameters.
open_cp_list企业微信应用渠道列表A
POST /open/cp/list - 获取企业微信应用列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(编号), cpName(应用名称), cpCode(应用编码)。
Inputs: current, pageSize.
open_file_upload_image通过开放接口上传图片A
POST /open/file/uploadImage - 使用 access-key 直接上传图片(multipart file)。 本工具入参为 filename + contentBase64,由 MCP 组装 multipart。 若需官方文档推荐的七牛直传流程,请先调用 open_user_image_upload_token。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 成功时 data 一般为图片 URL 字符串。
Inputs: filename (required), contentBase64 (required).
open_forward_log_detail消息规则触发记录详情A
GET /open/forwardLog/detail - 查看触发记录详情。 请求(url): logId(记录编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: id, ruleId, ruleName, sourceType, sourceTypeName, requestIp, requestMethod, requestHeaders, requestQuery, requestBody, variables, matchResult(匹配结果;0-条件不满足,1-已转发,2-频率限制,3-不在触发时间段,4-执行异常), matchResultName, shortCodes, errorMessage, createTime。
Inputs: logId (required).
open_forward_log_list消息规则触发记录列表A
POST /open/forwardLog/list - 获取触发记录列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 可按 ruleId、matchResult 筛选。 匹配结果;0-条件不满足,1-已转发,2-频率限制,3-不在触发时间段,4-执行异常。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id, ruleId, ruleName, sourceType, sourceTypeName, requestIp, matchResult, matchResultName, shortCodes, errorMessage, createTime。
Inputs: ruleId, current, pageSize, matchResult.
open_forward_rule_add新增消息规则A
POST /open/forwardRule/add - 新增消息规则(需会员才能开启)。 必填: ruleName。variables/targets/condition 传 JSON 字符串。 触发来源;0-全部,1-消息接口,2-邮件。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: ruleName (required), pre, sort, remark, +16 more.
open_forward_rule_change_status启用停用消息规则B
GET /open/forwardRule/changeStatus - 启用或停用消息规则。 请求(url): ruleId, status(1启用/0停用)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: ruleId (required), status (required).
open_forward_rule_delete删除消息规则B
DELETE /open/forwardRule/delete - 高风险:删除消息规则。 请求(url): ruleId(规则编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: ruleId (required).
open_forward_rule_detail消息规则详情A
GET /open/forwardRule/detail - 消息规则详情(需会员才能开启)。 请求(url): ruleId(规则编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data 含规则字段、condition、variables、targets。触发来源;0-全部,1-消息接口,2-邮件;变量来源;1-请求头,2-Query,3-请求体,4-URL路径,5-主题(邮件);提取方式;1-序列化数据,2-正则,3-JSONPath,4-原始全文。
Inputs: ruleId (required).
open_forward_rule_edit修改消息规则A
POST /open/forwardRule/edit - 修改消息规则(需会员才能开启);会整体覆盖变量和发送目标。 必填: id, ruleName。其余同新增。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required), ruleName (required), pre, sort, +17 more.
open_forward_rule_get_setting获取消息规则模式A
GET /open/forwardRule/setting - 获取消息规则总开关。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data.mode: 消息规则总开关;0-关闭(推送与原来一致),1-开启且未命中仍按默认推送,2-开启且未命中不推送。
Inputs: no named parameters.
open_forward_rule_list消息规则列表A
POST /open/forwardRule/list - 获取消息规则列表(需会员才能开启)。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id, tokenId(-1全部令牌/0用户令牌/>0消息令牌id), tokenName, ruleName, sourceType(触发来源;0-全部,1-消息接口,2-邮件), sourceTypeName, status(1启用/0停用), sort, conditionExpr, targetCount, createTime。
Inputs: current, pageSize.
open_forward_rule_save_setting设置消息规则模式B
GET /open/forwardRule/setting - 设置消息规则总开关。 mode为1或2时需开通会员,否则返回「消息规则需开通会员后才能开启」。 请求(url): mode(消息规则总开关;0-关闭(推送与原来一致),1-开启且未命中仍按默认推送,2-开启且未命中不推送)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: mode (required).
open_forward_rule_test测试消息规则A
POST /open/forwardRule/test - 用模拟请求测试规则,不会真正发送(需会员才能开启)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: variables, matched, conditionExpr, errorMessage, title, content, template。
Inputs: pre, body, query, title, +12 more.
open_friend_add_blacklist将好友加入黑名单A
POST /open/friend/addBlacklist - 高风险:将好友加入黑名单。 加入后将解除双方好友关系,对方无法再添加你。不能将自己加入黑名单,仅可将已有好友加入黑名单。 请求(url): friendId(好友id,必填;来自好友列表 friendId)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: friendId (required).
open_friend_blacklist_list好友黑名单列表A
POST /open/friend/blacklistList - 获取好友黑名单列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(黑名单记录ID,解除黑名单时使用), friendId(被拉黑好友ID), nickName, headImgUrl, createTime(拉黑时间)。
Inputs: current, pageSize.
open_friend_delete删除好友A
GET /open/friend/deleteFriend - 高风险:删除好友。 请求(url): friendId(好友id,必填;来自好友列表 friendId)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: friendId (required), appId.
open_friend_edit_remark修改好友备注A
POST /open/friend/editRemark - 修改好友备注。 请求: id(好友编号,必填;列表 id 字段), remark(备注,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required), remark (required).
open_friend_get_qr_code获取个人二维码A
GET /open/friend/getQrCode - 获取个人二维码(用于添加好友)。 请求(url): appId(微信公众号Id,可选), content(自定义参数,扫描后回调,可选), second(有效期秒,默认604800/7天,最长30天), scanCount(1-999或-1无限,默认-1)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: qrCodeImgUrl(二维码图片地址)。
Inputs: appId, second, content, scanCount.
open_friend_list好友列表A
POST /open/friend/list - 获取好友列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(好友编号), friendId(好友id), token(好友令牌,发送好友消息使用), headImgUrl, nickName, emailStatus(0/1/2), havePhone(0/1), isFollow(0/1), remark, createTime。
Inputs: current, pageSize.
open_friend_remove_blacklist解除好友黑名单A
POST /open/friend/removeBlacklist - 高风险:解除好友黑名单。 解除后不会自动恢复好友关系,需重新扫码添加。 请求(url): id(黑名单记录ID,必填;来自黑名单列表 id)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required).
open_get_access_key获取开放接口 AccessKeyA
POST /common/openApi/getAccessKey - 获取开放接口调用凭证。 使用环境变量 PUSHPLUS_TOKEN(用户token,不支持消息token) + PUSHPLUS_SECRET_KEY。 AccessKey 有效期约 7200 秒,重复获取会使上次失效;其他 open_* 工具会自动换取并缓存。 调用前需在官网开启开放接口,并配置安全IP(否则可能返回403)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: accessKey(访问令牌,后续请求放 header access-key), expiresIn(过期秒数)。
Inputs: no named parameters.
open_mail_detail邮箱渠道详情A
GET /open/mail/detail - 邮箱渠道详情。 请求(url): mailId(邮箱编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: id, mailName, mailCode, account(邮箱账户), password(邮箱密码), smtpServer, smtpSsl(1启用/0不启用), smtpPort, createTime。
Inputs: mailId (required).
open_mail_list邮箱渠道列表A
POST /open/mail/list - 获取邮箱渠道列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(邮箱编号), mailName(邮箱名称), mailCode(邮箱编码)。
Inputs: current, pageSize.
open_message_delete删除消息A
DELETE /open/message/deleteMessage - 高风险:删除后所有接收人均无法查看,且无法撤销。 请求: shortCode(消息短链码,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: shortCode (required).
open_message_list消息列表A
POST /open/message/list - 分页查询消息列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: channel(wechat/mail/cp/webhook/clawbot/cmcc/qq等), messageType(1一对一/2一对多), shortCode(消息短链码,可查发送结果), title(标题), topicName(群组名称,一对多才有), updateTime(更新时间)。
Inputs: isRead, channel, current, pageSize, +1 more.
open_message_send_result查询消息发送结果A
GET /open/message/sendMessageResult - 按 shortCode 查询投递结果。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: status(0未投递/1发送中/2已发送/3发送失败), errorMessage(失败原因), updateTime(更新时间)。
Inputs: shortCode (required).
open_mp_detail公众号详情A
GET /open/mp/detail - 公众号详情。 请求(url): id(微信公众号编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 公众号配置详情字段(同列表并可能更完整)。
Inputs: id (required).
open_mp_list微信公众号渠道列表A
POST /open/mp/list - 获取微信公众号渠道列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id, nickName, headImg, principalName(主体名称), authorizationAppid, funcInfo(权限集), serviceType(0订阅号/1历史升级订阅号/2服务号), verifyType(-1未认证/0微信认证), alias(微信号), updateTime。
Inputs: current, pageSize.
open_pay_transfer_order积分提现A
POST /open/pay/transferOrder - 高风险:发起积分提现。 请求: accountId(收款账户ID,必填), points(提现积分,可选)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 提现业务结果对象。
Inputs: accountId (required), points.
open_pre_add新增预处理信息A
POST /open/pre/add - 新增预处理(需会员)。 请求: content(预处理代码,必填), preName(名称,必填), preCode(编码,必填), contentType(编程语言;1-JavaScript,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 新建预处理编号(数字)。
Inputs: content (required), preCode (required), preName (required), contentType (required).
open_pre_delete删除预处理信息A
DELETE /open/pre/delete - 高风险:删除预处理(需会员)。 请求(url): preId(预处理编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「删除成功」。
Inputs: preId (required).
open_pre_detail预处理信息详情A
GET /open/pre/detail - 预处理详情(需会员)。 请求(url): preId(预处理编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: id, preName, preCode, contentType(1-JavaScript), content(预处理代码)。
Inputs: preId (required).
open_pre_edit修改预处理信息A
POST /open/pre/edit - 修改预处理(需会员)。 请求: id(编号,必填), content/preName/preCode/contentType(均为必填;contentType=1 JavaScript)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「修改成功」。
Inputs: id (required), content (required), preCode (required), preName (required), +1 more.
open_pre_list预处理信息列表A
POST /open/pre/list - 获取预处理列表(需会员)。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id, preName, preCode, contentType(1-JavaScript), createTime。
Inputs: current, pageSize.
open_pre_test测试预处理代码A
POST /open/pre/test - 测试预处理代码(需会员)。 请求: content(预处理代码,必填), contentType(1-JavaScript,必填), message(测试消息内容,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 预处理后的消息内容字符串。
Inputs: content (required), message (required), contentType (required).
open_qqbot_add新增 QQ 机器人配置A
POST /open/qqBot/add - 新增 QQ 机器人配置:发到指定QQ群(sendType=2),或用指定机器人发给自己(sendType=1)。 只用默认机器人发给自己时无需配置。 请求: qqName(配置名称,必填,最多64字符), qqCode(配置编码,必填,最多32字符,仅字母/数字/下划线/中划线,创建后不可修改), sendType(1发给自己/2发到QQ群,可选,默认2), qqGroupId(QQ群编号,sendType=2时必填,取自 groupList 的 id;该群需允许机器人主动消息), botAppId(机器人appId,sendType=1时必填且需已绑定;sendType=2时可不填,以群所在机器人为准)。 限制: 同一QQ群、同一机器人的“发给自己”均不可重复创建。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: qqCode (required), qqName (required), botAppId, sendType, +1 more.
open_qqbot_bot_infoQQ 机器人绑定状态A
GET /open/qqBot/botInfo - 查询 QQ 机器人绑定状态。 请求(url): botAppId(可选,不填为默认机器人)。botAppId 取自 open_qqbot_my_bots 返回的 bots[].botAppId。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: isBind(0未绑定/1已绑定), receiveStatus(1可接收/0用户已关闭单聊接收), createTime(绑定时间), botInfo(机器人详情: botId, username, avatar, botAppId, shareUrl(可用于拉机器人进群), botType(1官方机器人/2自有机器人))。
Inputs: botAppId.
open_qqbot_custom_bot_add添加自有 QQ 机器人A
POST /open/qqBot/customBot/add - 添加自有 QQ 机器人,凭证校验通过才保存。 限制: 普通用户最多1个,会员最多5个;官方机器人和已被其他账号添加的机器人不可添加。 添加后需用 open_qqbot_get_bind_link(传 botAppId) 完成绑定。 请求: botAppId(必填), appSecret(必填,敏感凭证,不要在回复中回显)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: botAppId (required), appSecret (required).
open_qqbot_custom_bot_delete删除自有 QQ 机器人A
DELETE /open/qqBot/customBot/delete - 高风险:删除自有 QQ 机器人, 同时解除其绑定并删除其QQ群和使用该机器人的配置,相关 option 将失效。 请求(url): botAppId(自有机器人AppID,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: botAppId (required).
open_qqbot_custom_bot_edit修改自有 QQ 机器人 AppSecretA
POST /open/qqBot/customBot/edit - 修改自有 QQ 机器人的 AppSecret(在QQ开放平台重置后同步),新凭证校验通过才保存。 请求: botAppId(已添加的机器人AppID,必填), appSecret(新AppSecret,必填,不要在回复中回显)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: botAppId (required), appSecret (required).
open_qqbot_custom_bot_preview校验自有 QQ 机器人凭证A
POST /open/qqBot/customBot/preview - 用 AppID 与 AppSecret 校验自有机器人并返回头像昵称,仅校验不保存。 需先在QQ开放平台把 open_qqbot_my_bots 返回的 serverIps 加入IP白名单。 请求: botAppId(必填), appSecret(必填,敏感凭证,不要在回复中回显)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: botId, username, avatar, botAppId, shareUrl(可用于拉机器人进群), botType(1官方机器人/2自有机器人)。
Inputs: botAppId (required), appSecret (required).
open_qqbot_custom_bot_refresh刷新自有 QQ 机器人信息B
GET /open/qqBot/customBot/refresh - 从QQ开放平台重新拉取自有机器人的头像昵称。 请求(url): botAppId(自有机器人AppID,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: botAppId (required).
open_qqbot_delete删除 QQ 机器人配置A
DELETE /open/qqBot/delete - 高风险:删除 QQ 机器人配置,删除后使用该编码的 option 将失效。 请求(url): id(配置编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required).
open_qqbot_edit修改 QQ 机器人配置A
POST /open/qqBot/edit - 修改 QQ 机器人配置。配置编码(qqCode)不允许修改,但需传原值。 请求: id(配置编号,必填), qqName(配置名称,必填), qqCode(原配置编码,必填), sendType(1发给自己/2发到QQ群,可选,默认2), qqGroupId(QQ群编号,sendType=2时必填,取自 groupList 的 id;该群需允许机器人主动消息), botAppId(机器人appId,sendType=1时必填且需已绑定;sendType=2时可不填,以群所在机器人为准)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required), qqCode (required), qqName (required), botAppId, +2 more.
open_qqbot_get_bind_linkQQ 机器人绑定链接A
GET /open/qqBot/getBindLink - 获取 QQ 机器人绑定链接与绑定码。 请求(url): refresh(是否强制刷新,可选,默认false;true 会使旧绑定码失效并重新生成), botAppId(可选,不填为分配的官方机器人;绑定自有机器人时必填)。botAppId 取自 open_qqbot_my_bots 返回的 bots[].botAppId。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: url(带参分享链接,可生成二维码;已绑定该机器人时可能为空), bindCode(绑定码,已是好友时需私聊发给机器人,认领QQ群也用此码), expireSeconds(有效期秒数,默认300), botAppId, botName(机器人名称), botAvatar(机器人头像), botType(1官方/2自有)。
Inputs: refresh, botAppId.
open_qqbot_group_listQQ 机器人已加入群列表A
GET /open/qqBot/groupList - 获取机器人已加入的 QQ 群列表。 请求(url): botAppId(可选,填写时只返回该机器人所在的群,不填返回全部)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 数组,项含 id(QQ群编号,新增群配置时作为 qqGroupId), groupOpenId, groupRemark, status(1在群/0已退群/2群消息接收关闭), groupName(接口未授权时为空), groupFingerMemo(群简介), groupClassText(群分类), groupTags(群标签), groupMemberNum(群成员数), createTime。
Inputs: botAppId.
open_qqbot_listQQ 机器人配置列表A
POST /open/qqBot/list - 获取 QQ 机器人配置列表(发到QQ群或用指定机器人发给自己)。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(配置编号), qqName(配置名称), qqCode(配置编码,发送消息时作为 option 传入), sendType(1发给自己/2发到QQ群), qqGroupId(QQ群编号,sendType=2时返回), groupRemark, groupOpenId, groupName, botAppId(发送使用的机器人appId), botName, botAvatar, updateTime。
Inputs: current, pageSize.
open_qqbot_my_bots我的 QQ 机器人列表A
GET /open/qqBot/myBots - 我的 QQ 机器人列表:官方机器人与自有机器人及其绑定状态,附带接入自有机器人需要的信息。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: bots(数组,官方在前自有在后;项含 botAppId, botId, username, avatar, shareUrl, botType(1官方/2自有), isBind(0/1), receiveStatus(1可接收/0已关闭单聊接收), isDefault(1默认机器人), bindTime), customBotCount(已添加自有机器人数), customBotLimit(可添加上限,普通1个/会员5个), webhookUrl(需在QQ开放平台配置的回调地址), serverIps(需加入QQ开放平台IP白名单的IP), events(需订阅的事件)。
Inputs: no named parameters.
open_qqbot_set_default设置默认 QQ 机器人A
GET /open/qqBot/setDefault - 设置默认 QQ 机器人;发送消息 channel=qq 且不填 option 时由默认机器人发给自己。 请求(url): botAppId(必填,须已绑定)。botAppId 取自 open_qqbot_my_bots 返回的 bots[].botAppId。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: botAppId (required).
open_qqbot_unbind解绑 QQ 机器人A
GET /open/qqBot/unbind - 高风险:解绑 QQ 机器人。 请求(url): botAppId(可选,不填解绑官方机器人)。解绑默认机器人后会自动把其他已绑定机器人设为默认。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: botAppId.
open_setting_add_user_default新增默认配置A
POST /open/setting/addUserDefault - 新增默认推送配置。 请求: channel(渠道编码;wechat微信公众号,cp企业微信应用,webhook第三方webhook,mail邮件,sms短信,voice语音,extension插件,clawbot微信ClawBot,cmcc新消息ClawBot,qq QQ机器人,必填), option(渠道参数,必填), pre(预处理编码,必填可空串), tokenId(消息令牌id,必填;用户令牌填0)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: pre (required), option (required), channel (required), tokenId (required).
open_setting_change_default_channel修改默认渠道(已废弃)A
POST /open/setting/changeDefaultChannel - 已废弃,请改用 add/editUserDefault。请求: defaultChannel, defaultWebhook(可选)。统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: defaultChannel (required), defaultWebhook.
open_setting_change_is_send开启/关闭发送消息功能A
GET /open/setting/changeIsSend - 开启或禁用发送消息功能。 请求(url): isSend(0禁用/1启用,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: isSend (required).
open_setting_change_open_message_type修改打开消息方式B
GET /open/setting/changeOpenMessageType - 修改消息打开类型。 请求(url): openMessageType(0:H5,1:小程序,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: openMessageType (required).
open_setting_change_receive_limit修改接收消息限制A
GET /open/setting/changeRecevieLimit - 修改接收消息限制。 请求(url): recevieLimit(0接收全部/1不接收消息,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: recevieLimit (required).
open_setting_delete_user_default删除默认配置A
DELETE /open/setting/deleteUserDefault - 高风险:删除默认配置。 请求(url): id(默认配置编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「默认配置删除成功」。
Inputs: id (required).
open_setting_detail_user_default默认配置详情B
GET /open/setting/detailUserDefault - 默认配置详情。 请求(url): id(默认配置编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: id, channel(渠道编码;wechat微信公众号,cp企业微信应用,webhook第三方webhook,mail邮件,sms短信,voice语音,extension插件,clawbot微信ClawBot,cmcc新消息ClawBot,qq QQ机器人), option(渠道参数), pre(预处理编码), updateTime, name, tokenId(消息令牌id;用户令牌为0)。
Inputs: id (required).
open_setting_edit_user_default修改默认配置C
POST /open/setting/editUserDefault - 修改默认推送配置。 请求: id(必填), channel(必填), tokenId(必填;用户令牌0), option/pre(可选)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「修改成功」。
Inputs: id (required), channel (required), tokenId (required), pre, +1 more.
open_setting_extension修改插件渠道转发C
GET /open/setting/extension - 微信渠道消息是否同步浏览器扩展/桌面应用。 请求(url): forward(0否/1是,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: forward (required).
open_setting_get_user_settings获取默认渠道(已废弃)A
GET /open/setting/getUserSettings - 已废弃,请改用 listUserDefault/detailUserDefault。统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: no named parameters.
open_setting_list_user_default默认配置列表A
POST /open/setting/listUserDefault - 按消息token配置的默认推送渠道列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(默认配置编号), channel(渠道编码;wechat微信公众号,cp企业微信应用,webhook第三方webhook,mail邮件,sms短信,voice语音,extension插件,clawbot微信ClawBot,cmcc新消息ClawBot,qq QQ机器人), channelTxt(渠道名称), updateTime, name(令牌名称)。
Inputs: current, pageSize.
open_token_add新增消息 tokenA
POST /open/token/add - 新增消息 token。 请求: name(令牌名称,必填), expireTime(过期时间,可选,默认2999-12-31)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 新建的消息 token 字符串。
Inputs: name (required), expireTime.
open_token_delete删除消息 tokenA
DELETE /open/token/deleteToken - 高风险:删除消息 token。 请求(url): id(消息token编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「删除成功」。
Inputs: id (required).
open_token_edit修改消息 tokenA
POST /open/token/edit - 修改消息 token。 请求: id(编号,必填), name(令牌名称,必填), expireTime(过期时间,可选,默认2999-12-31)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「修改成功」。
Inputs: id (required), name (required), expireTime.
open_token_list消息 token 列表A
POST /open/token/list - 分页获取消息 token 列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(消息token编号), name(令牌名称), expireTime(过期时间), token(消息token字符串)。
Inputs: current, pageSize.
open_topic_add新增群组A
POST /open/topic/add - 新增群组。 请求: topicCode(编码,必填), topicName(名称,必填), contact(联系方式,必填), introduction(简介,必填), receiptMessage(加入后回复,可选), appId(绑定公众号Id,可选,默认pushplus公众号), icon(可选), topicType(可选,默认0;群组类型;0普通群组;1积分群组;2公开群组), price(可选,默认0), topicDescribe(一句话介绍,可选)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 新建群组编号(数字)。
Inputs: contact (required), topicCode (required), topicName (required), introduction (required), +6 more.
open_topic_delete删除群组B
GET /open/topic/delete - 高风险:删除群组。 请求(url): topicId(群组编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「群组删除成功」。
Inputs: topicId (required).
open_topic_detail我创建的群组详情A
GET /open/topic/detail - 获取我创建的群组详情。 请求(url): topicId(群组编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: topicId, topicCode, topicName, qrCodeImgUrl(永久二维码), contact, introduction, receiptMessage(加入后回复), nickName, createTime, topicUserCount, icon, appId, topicType(群组类型;0普通群组;1积分群组;2公开群组), price(积分群组订阅积分/月), topicDescribe, userNickName, isApproved/firstIsApproved(是否审核通过;0未审核,1审核不通过,2审核通过), approveReason, isOpen(0否/1是)。
Inputs: topicId (required).
open_topic_edit修改群组A
POST /open/topic/editTopic - 修改群组信息。 请求: topicId(群组编号,必填), topicCode(编码,必填), topicName(名称,必填), contact/introduction/receiptMessage/icon/price/topicDescribe(可选)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「修改成功」。
Inputs: topicId (required), topicCode (required), topicName (required), icon, +5 more.
open_topic_exit退出群组B
GET /open/topic/exitTopic - 高风险:退出/退订群组。 请求(url): topicId(群组编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「退订成功」。
Inputs: topicId (required).
open_topic_is_open上下架积分群组A
POST /open/topic/isOpen - 积分群组上下架。 请求: topicId(群组编号,必填), isOpen(1上架/0下架,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「操作成功」。
Inputs: isOpen (required), topicId (required).
open_topic_join_detail我加入的群组详情B
GET /open/topic/joinTopicDetail - 获取我加入的群详情。 请求(url): topicId(群组编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: topicId, topicCode, topicName, contact, introduction, nickName, createTime(加入时间), icon, topicUserCount, topicType(群组类型;0普通群组;1积分群组;2公开群组), price, topicDescribe, userNickName。
Inputs: topicId (required).
open_topic_list群组列表A
POST /open/topic/list - 获取群组列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 params.topicType(必填语义:0我创建的/1我加入的,默认0)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: icon, topicId, topicCode, topicName, nickName(所属公众号), createTime, topicUserCount, topicType(群组类型;0普通群组;1积分群组;2公开群组), isApproved(是否审核通过;0未审核,1审核不通过,2审核通过), firstIsApproved(是否审核通过;0未审核,1审核不通过,2审核通过), approveReason(审批拒绝理由), isOpen(积分群组是否上架;0否/1是)。
Inputs: current, pageSize, topicType.
open_topic_qr_code获取群组二维码A
GET /open/topic/qrCode - 获取群组二维码。 请求(url): topicId(必填), second(有效期秒,默认604800即7天,最长30天), scanCount(可扫码次数1-999,-1无限,默认-1)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: qrCodeImgUrl(二维码图片路径), forever(0临时二维码/1永久二维码)。
Inputs: topicId (required), second, scanCount.
open_topic_user_add_blacklist将订阅人加入黑名单A
POST /open/topicUser/addBlacklist - 高风险:将订阅人加入黑名单。 加入后将移出群组,对方无法再加入该群组。积分群组不支持黑名单。不能将自己加入黑名单。 请求(url): topicRelationId(用户编号,必填;来自订阅人列表 id)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: topicRelationId (required).
open_topic_user_blacklist_list订阅人黑名单列表A
POST /open/topicUser/blacklistList - 获取群组订阅人黑名单列表。 积分群组不支持黑名单。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 params.topicId(群组编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(黑名单记录ID,解除黑名单时使用), userId(被拉黑用户ID), nickName, openId, headImgUrl, createTime(拉黑时间)。
Inputs: topicId (required), current, pageSize.
open_topic_user_delete删除群组内用户A
POST /open/topicUser/deleteTopicUser - 高风险:删除群组订阅用户。 请求(url): topicRelationId(用户编号,必填;来自订阅人列表的 id)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「删除成功」。
Inputs: topicRelationId (required).
open_topic_user_edit_remark修改订阅人备注B
POST /open/topicUser/editRemark - 修改订阅人备注。 请求: id(用户编号,必填), remark(备注,必填,20字以内)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required), remark (required).
open_topic_user_remove_blacklist解除订阅人黑名单A
POST /open/topicUser/removeBlacklist - 高风险:解除订阅人黑名单。 解除后不会自动恢复群组订阅,对方可重新加入该群组。 请求(url): id(黑名单记录ID,必填;来自黑名单列表 id)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required).
open_topic_user_subscriber_list获取群组内用户A
POST /open/topicUser/subscriberList - 获取群组订阅人列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 params.topicId(群组编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(用户编号,可用于删除), nickName, openId, headImgUrl, userSex(0未设置/1男/2女), havePhone(0未绑定/1已绑定), isFollow(0未关注/1已关注), emailStatus(0未验证/1待验证/2已验证), followTime(关注群组时间), remark(备注)。
Inputs: topicId (required), current, pageSize.
open_user_image_delete删除图片B
DELETE /open/userImage/delete - 高风险:主动删除图片。 请求(url): id(图片id,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: id (required).
open_user_image_list图片列表A
POST /open/userImage/list - 查询已上传图片列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 默认 pageSize 可为10;最大50。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id(图片id), imgUrl(图片地址), thumbnail(缩略图), createTime。 未删除图片默认 30 天后系统自动清理。
Inputs: current, pageSize.
open_user_image_upload_token获取图片上传凭证A
GET /open/userImage/uploadToken - 获取七牛云表单上传凭证(图片服务,30天有效)。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: uploadToken(上传凭证), uploadHost(上传域名), uploadUrl(上传地址), bucket(存储桶), expiresIn(凭证有效秒数)。 拿到凭证后按七牛表单规范向 uploadUrl 提交 token+file(无需 access-key)。
Inputs: no named parameters.
open_user_limit_time获取解封剩余时间A
GET /open/user/userLimitTime - 查询发送限制与解封时间。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: sendLimit(1无限制/2短期限制/3永久限制), userLimitTime(解封时间字符串)。
Inputs: no named parameters.
open_user_my_info个人资料详情A
GET /open/user/myInfo - 获取个人资料。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data 字段: openId(微信openId), unionId(微信unionId), nickName(昵称), headImgUrl(头像), userSex(0未设置/1男/2女), token(用户令牌), phoneNumber(手机号), email(邮箱), emailStatus(0未验证/1待验证/2已验证), birthday(生日), points(积分), verifyStatus(0未实名/1已实名), vipInfo{isVip(0否/1是), lastDay(会员到期日)}。
Inputs: no named parameters.
open_user_send_count查询当日消息接口请求次数A
GET /open/user/sendCount - 查询当日各渠道消息接口请求次数。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: wechatSendCount(微信公众号), cpSendCount(企业微信应用), webhookSendCount(webhook), mailSendCount(邮件), smsSendCount(短信), extensionCount(插件), voiceSendCount(语音), appSendCount(App), clawBotSendCount(微信ClawBot), qqBotSendCount(QQ机器人), cmccSendCount(新消息ClawBot)。
Inputs: no named parameters.
open_user_token获取用户 tokenA
GET /open/user/token - 获取当前用户 token。 请求参数: 无。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 字符串,直接为当前用户 token。
Inputs: no named parameters.
open_webhook_add新增 webhookA
POST /open/webhook/add - 新增 webhook 配置。 请求: webhookCode(编码,必填), webhookName(名称,必填), webhookType(webhook类型;1企业微信机器人,2钉钉,3飞书,4Server酱,50bark,6企业微信应用,7腾讯轻联,8IFTTT,9集简云,10Gotify,11WxPusher,12自定义,必填), webhookUrl(调用url,必填), httpMethod/headers/body(仅自定义类型12需要)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 新建 webhook 编号(数字)。
Inputs: webhookUrl (required), webhookCode (required), webhookName (required), webhookType (required), +3 more.
open_webhook_delete删除 webhookA
GET /open/webhook/delete - 高风险:删除 webhook。 请求(url): webhookId(webhook编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。
Inputs: webhookId (required).
open_webhook_detailwebhook 详情A
GET /open/webhook/detail - 查看 webhook 详情。 请求(url): webhookId(webhook编号,必填)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: id, webhookCode, webhookName, webhookType(webhook类型;1企业微信机器人,2钉钉,3飞书,4Server酱,50bark,6企业微信应用,7腾讯轻联,8IFTTT,9集简云,10Gotify,11WxPusher,12自定义), webhookTypeName, webhookUrl, createTime, httpMethod/headers/body(仅自定义类型返回)。
Inputs: webhookId (required).
open_webhook_edit修改 webhookA
POST /open/webhook/edit - 修改 webhook 配置。 请求: id(编号,必填), webhookCode/Name/Type/Url(必填), httpMethod/headers/body(自定义类型可选)。 webhookType: webhook类型;1企业微信机器人,2钉钉,3飞书,4Server酱,50bark,6企业微信应用,7腾讯轻联,8IFTTT,9集简云,10Gotify,11WxPusher,12自定义。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 data: 如「修改成功」。
Inputs: id (required), webhookUrl (required), webhookCode (required), webhookName (required), +4 more.
open_webhook_listwebhook 列表A
POST /open/webhook/list - 获取 webhook 列表。 分页请求: current(当前页,默认1), pageSize(每页大小,默认20,最大50)。 统一响应: code(数字,200成功), msg(字符串), data(业务数据)。 分页响应 data: pageNum(当前页), pageSize(分页大小), total(总行数), pages(总页数), list(列表)。 list 项: id, webhookCode, webhookName, webhookType(webhook类型;1企业微信机器人,2钉钉,3飞书,4Server酱,50bark,6企业微信应用,7腾讯轻联,8IFTTT,9集简云,10Gotify,11WxPusher,12自定义), webhookTypeName, webhookUrl, createTime。
Inputs: current, pageSize.
send_html_message发送HTML消息C
发送带有HTML格式的推送消息(template=html)
Inputs: content (required), to, pre, title, +2 more.
send_json_message发送JSON消息B
发送JSON格式的推送消息(template=json)
Inputs: content (required), to, pre, title, +2 more.
send_markdown_message发送Markdown消息C
发送Markdown格式的推送消息(template=markdown)
Inputs: content (required), to, pre, title, +2 more.
send_push_message发送推送消息C
通过 pushplus /send 接口发送推送消息。form/doc/excel/webdiff 模板必须传 pushId。
Inputs: content (required), to, pre, icon, +9 more.
send_text_message发送文本消息A
快速发送纯文本推送消息(template=txt)
Inputs: content (required), to, pre, title, +2 more.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 107 tools
Most tools map to distinct resource+action pairs (e.g., open_token_*, open_topic_*), but several overlapping families exist: six send_* tools for templated sending, two image-upload paths (open_user_image_upload_token vs open_file_upload_image), and deprecated settings tools alongside replacements. The sheer volume increases misselection risk even when descriptions are detailed.
Nearly all tools use snake_case with an open_ prefix and domain_action pattern, which is highly readable. The main deviation is the send_* family and batch_send_message, which omit the open_ prefix, plus minor variations like open_clawbot vs open_cmcc. Still, no chaotic mixing.
107 tools is an extreme mismatch for a single MCP server, far beyond the 3-15 sweet spot and even the 25+ heavy threshold. The surface includes deprecated and convenience tools that could be consolidated, making the server overwhelming for agents.
The set covers a very broad PushPlus API surface: messaging, tokens, topics, topic users, friends, webhooks, settings, preprocessing, forwarding rules/logs, mail/mp/cp channels, QQ/ClawBot/CMCC bots, images, and pay. Minor gaps include deprecated settings tools and read-only mail/mp/cp channels, but core lifecycle operations are largely present.
Maintenance
Related MCP Connectors
Send yourself a push notification from an AI assistant. No account, one environment variable.
Push notifications for AI agents - send instant iPhone notifications from any MCP client.
Let your AI agent notify you by email, Slack, Discord, or webhook. One tool: send_notification.
Build and send email, SMS, and push straight from your AI agent.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables AI assistants to send push notifications through the kweenkl service. Allows users to receive contextual notifications from their AI when tasks are complete or important events occur.14 npmMIT
- AlicenseBqualityDmaintenanceEnables AI assistants to send push notifications to mobile devices via Pushover, allowing users to receive instant alerts for task completions, errors, reminders, and custom messages through their AI conversations.16 npm2MIT
- AlicenseAqualityDmaintenanceEnables AI assistants to send push notifications and interactive alerts to iPhone and Mac devices via the BotBell app. It allows AI to receive user replies and manage notification bots for tasks like alerts, reminders, and remote approvals.29 npm1MIT
- AlicenseBqualityDmaintenanceEnables sending push notifications via Bark and PushDeer services, supporting message, markdown, and image notifications.1MIT