API 文档

← 返回首页

快速开始

  1. 注册账号登录
  2. 在「应用」页面创建一个 App,拿到 sendkey
  3. 在「通道」页面配置至少一个推送通道(Bark / 飞书 / 钉钉 / Telegram / Server酱 / 邮件),点「🧪 发送测试」验证
  4. 在你的脚本里调用发送 API,消息会分发到所有启用的通道

发送 API

方式一:Server酱 兼容(最简单)

完全兼容 Server酱 的 URL 格式,现有用 Server酱 的脚本只需改域名和 key。

# GET(最简)
curl "http://161.118.217.129:3001/send/<你的sendkey>.send?title=标题&desp=正文"

# POST(JSON)
curl -X POST "http://161.118.217.129:3001/send/<你的sendkey>.send" \
  -H "Content-Type: application/json" \
  -d '{"title":"标题","desp":"正文"}'

方式二:正式 API(支持指定通道)

curl -X POST http://161.118.217.129:3001/api/v1/send \
  -H "Authorization: Bearer <你的sendkey>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "抢购成功",
    "desp": "订单已锁定,速去支付",
    "channels": ["BARK", "FEISHU"]
  }'

channels 可选,不传则发到所有启用的通道。

返回格式

{
  "code": 0,
  "message": "发送成功",
  "data": {
    "anyOk": true,
    "messageId": "cmr8...",
    "remaining": 59,
    "channels": [
      { "channel": "cmr8...", "type": "BARK", "ok": true },
      { "channel": "cmr8...", "type": "FEISHU", "ok": true }
    ]
  }
}

anyOk: true 表示至少一个通道成功(fail-soft,单通道失败不影响其他)。

错误码

HTTPcode含义
2000成功(注意 anyOk 可能 false)
400400参数错误
401401sendkey 无效或 App 禁用
429429限流(超过 App 的 次/分钟 配置)

支持的通道

Bark
服务器地址 + 设备 Key
iPhone 系统通知
飞书
群机器人 Webhook(可加签)
飞书 APP
钉钉
群机器人 Webhook(可加签)
钉钉 APP
Telegram
Bot Token + Chat ID(可代理)
Telegram APP
Server酱
你的 Server酱 SendKey
你的微信
邮件
SMTP 配置
邮箱

代码示例

// Node.js
const res = await fetch("http://161.118.217.129:3001/send/<sendkey>.send?" +
  new URLSearchParams({ title: "抢购成功", desp: "订单已锁定" }));
const data = await res.json();
console.log(data.data.anyOk ? "✓ 已推送" : "✗ 失败");

// Python
import requests
r = requests.post("http://161.118.217.129:3001/send/<sendkey>.send",
    json={"title": "抢购成功", "desp": "订单已锁定"})
print(r.json())