&channel=<推送方式>&token=<推送 token>`
1. `title`:选填,受限于具体的消息推送方式,其可能被忽略。
2. `description`:必填,可以替换为 `desp`。
3. `content`:选填,受限于具体的消息推送方式,Markdown 语法的支持有所区别。
4. `channel`:选填,如果不填则系统使用你在后台设置的默认推送通道。注意,此处填的是消息通道的名称,而非类型。可选的推送通道类型有:
1. `email`:通过发送邮件的方式进行推送(使用 `title` 或 `description` 字段设置邮件主题,使用 `content` 字段设置正文,支持完整的 Markdown 语法)。
2. `test`:通过微信测试号进行推送(使用 `description` 字段设置模板消息内容,不支持 Markdown)。
3. `corp_app`:通过企业微信应用号进行推送(仅当使用企业微信 APP 时,如果设置了 `content` 字段,`title` 和 `description` 字段会被忽略;使用微信中的企业微信插件时正常)。
4. `lark_app`:通过飞书自建应用进行推送。
5. `corp`:通过企业微信群机器人推送(设置 `content` 字段则将渲染 Markdown 消息,支持 Markdown 的子集;设置 `description` 字段则为普通文本消息)。
6. `lark`:通过飞书群机器人进行推送(注意事项同上)。
7. `ding`:通过钉钉群机器人进行推送(注意事项同上)。
8. `bark`:通过 Bark 进行推送(支持 `title` 和 `description` 字段)。
9. `client`:通过 WebSocket 客户端进行推送(支持 `title` 和 `description` 字段)。
10. `telegram`:通过 Telegram 机器人进行推送(`description` 或 `content` 字段二选一,支持 Markdown 的子集)。
11. `discord`:通过 Discord 群机器人进行推送(注意事项同上)。
12. `one_api`:通过 OneAPI 协议推送消息到 QQ。
13. `group`:通过预先配置的消息推送通道群组进行推送。
14. `custom`:通过预先配置好的自定义推送通道进行推送。
15. `none`:仅保存到数据库,不做推送。
5. `token`:如果你在后台设置了推送 token,则此项必填。另外可以通过设置 HTTP `Authorization` 头部设置此项。
6. `url`:选填,如果不填则系统自动为消息生成 URL,其内容为消息详情。
7. `to`:选填,推送给指定用户,如果不填则默认推送给自己,受限于具体的消息推送方式,有些推送方式不支持此项。
1. `@all`:推送给所有用户。
2. `user1|user2|user3`:推送给多个用户,用户之间使用 `|` 分隔。
8. `async`:选填,如果设置为 `true` 则消息推送将在后台异步进行,返回结果包含 `uuid` 字段,可用于后续[获取消息发送状态](./docs/API.md#通过消息 UUID 获取消息发送状态)。
3. `POST` 请求方式:字段与上面 `GET` 请求方式保持一致。
+ 注意:请求体编码格式为 `application/json`,`v0.3.2` 版本起支持 Post Form。
**各种通道的支持程度:**
| 通道类型 | `title` | `description` | `content` | `url` | `to` | Markdown 支持 |
|:----------:|:-------:|:-------------:|:---------:|:-----:|:----:|:-----------:|
| `email` | ✅ | ✅ | ✅ | ❌ | ✅️ | ✅️ |
| `test` | ✅ | ✅ | ✅ | ✅️ | ✅️ | ✅ |
| `corp_app` | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ |
| `corp` | ❌ | ✅ | ✅ | ✅️ | ✅️ | ✅ |
| `lark` | ❌ | ✅ | ✅ | ❌ | ✅ | ✅ |
| `lark_app` | ❌ | ✅ | ✅ | ❌️ | ✅ | ✅ |
| `ding` | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ |
| `bark` | ✅ | ✅ | ✅ | ✅️ | ❌ | ✅ |
| `client` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| `telegram` | ❌ | ❌ | ✅ | ❌ | ✅ | ✅ |
| `discord` | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ |
注意:
1. 对于大部分通道,`description` 字段和 `content` 是不能同时存在的,如果你只需要文字消息,请使用 `description` 字段,如果你需要发送 Markdown 消息,请使用 `content` 字段。
2. 部分通道的 Markdown 支持实际上是通过 URL 跳转到本系统所渲染的消息详情实现的,其他通道的 Markdown 支持受限于具体的通道,支持的语法并不统一。
**示例:**
Bash 示例
```shell
#!/bin/bash
MESSAGE_PUSHER_SERVER="https://msgpusher.com"
MESSAGE_PUSHER_USERNAME="test"
MESSAGE_PUSHER_TOKEN="666"
function send_message {
# POST Form
curl -s -X POST "$MESSAGE_PUSHER_SERVER/push/$MESSAGE_PUSHER_USERNAME" \
-d "title=$1&description=$2&content=$3&token=$MESSAGE_PUSHER_TOKEN" \
>/dev/null
}
function send_message_with_json {
# POST JSON
curl -s -X POST "$MESSAGE_PUSHER_SERVER/push/$MESSAGE_PUSHER_USERNAME" \
-H 'Content-Type: application/json' \
-d '{"title":"'"$1"'","desp":"'"$2"'", "content":"'"$3"'", "token":"'"$MESSAGE_PUSHER_TOKEN"'"}' \
>/dev/null
}
send_message 'title' 'description' 'content'
```
Python 示例
```python
import requests
SERVER = "https://msgpusher.com"
USERNAME = "test"
TOKEN = "666"
def send_message(title, description, content):
# GET 方式
# res = requests.get(f"{SERVER}/push/{USERNAME}?title={title}"
# f"&description={description}&content={content}&token={TOKEN}")
# POST 方式
res = requests.post(f"{SERVER}/push/{USERNAME}", json={
"title": title,
"description": description,
"content": content,
"token": TOKEN
})
res = res.json()
if res["success"]:
return None
else:
return res["message"]
error = send_message("标题", "描述", "**Markdown 内容**")
if error:
print(error)
```
Go 示例
```go
package main
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/url"
)
var serverAddress = "https://msgpusher.com"
var username = "test"
var token = "666"
type request struct {
Title string `json:"title"`
Description string `json:"description"`
Content string `json:"content"`
URL string `json:"url"`
Channel string `json:"channel"`
Token string `json:"token"`
}
type response struct {
Success bool `json:"success"`
Message string `json:"message"`
}
func SendMessage(title string, description string, content string) error {
req := request{
Title: title,
Description: description,
Content: content,
Token: token,
}
data, err := json.Marshal(req)
if err != nil {
return err
}
resp, err := http.Post(fmt.Sprintf("%s/push/%s", serverAddress, username),
"application/json", bytes.NewBuffer(data))
if err != nil {
return err
}
var res response
err = json.NewDecoder(resp.Body).Decode(&res)
if err != nil {
return err
}
if !res.Success {
return errors.New(res.Message)
}
return nil
}
func SendMessageWithForm(title string, description string, content string) error {
resp, err := http.PostForm(fmt.Sprintf("%s/push/%s", serverAddress, username),
url.Values{"title": {title}, "description": {description}, "content": {content}, "token": {token}})
if err != nil {
return err
}
var res response
err = json.NewDecoder(resp.Body).Decode(&res)
if err != nil {
return err
}
if !res.Success {
return errors.New(res.Message)
}
return nil
}
func main() {
//err := SendMessage("标题", "描述", "**Markdown 内容**")
err := SendMessageWithForm("标题", "描述", "**Markdown 内容**")
if err != nil {
fmt.Println("推送失败:" + err.Error())
} else {
fmt.Println("推送成功!")
}
}
```
C# 示例
```csharp
using Newtonsoft.Json;
using RestSharp;
namespace Demo
{
public class Program
{
public static void Main(string[] args)
{
//推送消息
var sendMsg = MessagePusherTool.SendMessage("标题", "描述", "**Markdown 内容**");
if(sendMsg.Success)
{
Console.WriteLine($"推送成功!");
}
else
{
Console.WriteLine($"推送失败:{sendMsg.Message}");
}
}
}
///
/// 消息推送工具
///
/// 开源地址:https://github.com/songquanpeng/message-pusher
/// 支持:Framework、Net3.1、Net5、Net6
/// 引用包:
/// dotnet add package Newtonsoft.Json -v 13.0.2
/// dotnet add package RestSharp -v 108.0.3
///
public class MessagePusherTool
{
///
/// ServerAddress
///
public const string ServerAddress = "https://msgpusher.com";
///
/// UserName
///
public const string UserName = "test";
///
/// Token
///
public const string Token = "666";
///
/// SendMessage
///
///
title
///
description
///
content
public static Response SendMessage(string title, string description, string content)
{
var requestData = new Request()
{
Title = title,
Description = description,
Content = content,
Token = Token,
};
var url = $"{ServerAddress}";
var client = new RestClient(url);
var request = new RestRequest($"push/{UserName}", Method.Post);
request.AddJsonBody(requestData);
var response = client.Execute(request);
var responseData = response.Content;
var responseJson = JsonConvert.DeserializeObject
(responseData);
return responseJson;
}
///
/// Request
///
public class Request
{
///
/// Title
///
[JsonProperty(PropertyName = "title")]
public string Title { get; set; }
///
/// Description
///
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
///
/// Content
///
[JsonProperty(PropertyName = "content")]
public string Content { get; set; }
///
/// URL
///
[JsonProperty(PropertyName = "url")]
public string URL { get; set; }
///
/// Channel
///
[JsonProperty(PropertyName = "channel")]
public string Channel { get; set; }
///
/// Token
///
[JsonProperty(PropertyName = "token")]
public string Token { get; set; }
}
///
/// Response
///
public class Response
{
///
/// Success
///
[JsonProperty(PropertyName = "success")]
public bool Success { get; set; }
///
/// Message
///
[JsonProperty(PropertyName = "message")]
public string Message { get; set; }
}
}
}
```
Node.js 示例
```javascript
const axios = require('axios');
const querystring = require('querystring');
const MESSAGE_PUSHER_SERVER = 'https://msgpusher.com'
const MESSAGE_PUSHER_USERNAME = 'test'
const MESSAGE_PUSHER_TOKEN = '666'
async function send_message(title, description, content) {
try {
const postData = querystring.stringify({
title: title,
desp: description,
content: content,
token: MESSAGE_PUSHER_TOKEN,
})
const response = await axios.post(`${MESSAGE_PUSHER_SERVER}/push/${MESSAGE_PUSHER_USERNAME}`, postData, {
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
})
if (response.data.success) {
return response.data
}
} catch (error) {
if (error.response) {
return error.response.data
} else {
throw error
}
}
}
send_message('标题', '描述', '**Markdown 内容**')
.then((response) => {
if (response.success) {
console.log('推送成功:', response)
} else {
console.log('推送失败:', response)
}
}, (error) => {
console.log(error.message);
})
```
欢迎 PR 添加更多语言的示例。
## 迁移数据库
此处均以 SQLite 为例,其他数据库请自行修改。我已经让 ChatGPT 翻译成对应的 SQL 版本,见 `bin` 文件夹,供参考。
### 从 `v0.3` 迁移到 `v0.4`
1. 首先备份你的数据库文件。
2. 下载最新的 `v0.4` 版本,启动程序,程序会自动进行数据库表结构的迁移。
3. 终止程序。
4. 之后执行脚本:`./bin/migrate_v3_to_v4.py`,进行数据的迁移。
5. 重新启动程序即可。
注意,执行前请确保数据库中 `users` 表中字段的顺序和脚本中的一致,否则会出现数据错乱的情况。
## 其他
1. `v0.3` 之前的版本基于 Node.js,你可以切换到 [`nodejs`](https://github.com/songquanpeng/message-pusher/tree/nodejs) 分支查看,该版本不再有功能性更新。
2. `v0.3` 以及后续版本基于 Gin Template [`v0.2.1`](https://github.com/songquanpeng/gin-template) 版本开发。
3. 如果想要自行编译,请首先[编译前端](./web/README.md),之后再编译后端,否则会遇到 `pattern web/build: no matching files found` 问题。