STATUS · OPERATIONAL

消息推送 API

通过简单的 HTTP 调用，向指定用户推送文本或 HTML 消息。无需 SDK，一个 URL 即可完成集成。

BASE · HTTPS https://api.chuckfang.com/

BASE · HTTP http://api.chuckfang.com/

协议 HTTP / HTTPS 方法 GET · POST 文档 chuckfang.com/MeoW/api_doc.html

🤖 本页内嵌机器可读的 OpenAPI 3.1 规范，位于 <script id="openapi-spec" type="application/json"> 元素中，AI agent 可直接解析该 JSON，无需抓取页面样式。

请求方式

支持协议：HTTP / HTTPS，推荐使用 HTTPS 以保证传输安全。
支持方法：GET 与 POST，可按场景任选。

GET请求

URL 格式

endpoint

http://api.chuckfang.com/{昵称}/{title}/{msg}?url={url}&imgUrl={imgUrl}&msgType={msgType}&htmlHeight={htmlHeight}
# 或省略 title
http://api.chuckfang.com/{昵称}/{msg}?url={url}&imgUrl={imgUrl}&msgType={msgType}&htmlHeight={htmlHeight}

参数说明

参数	位置	必填	说明
昵称	路径	必填	用户昵称（不允许包含斜杠）
title	路径	可选	消息标题，省略时默认使用 “MeoW”
msg	路径	必填	消息内容
url	查询	可选	跳转链接（需 URL 编码）
imgUrl	查询	可选	通知图标 URL（需 URL 编码）。建议格式 216×216、`PNG`
msgType	查询	可选	消息显示类型：`text`（默认，纯文本）、`html`（在 App 中渲染 HTML）、`markdown`（在 App 中渲染 Markdown）
htmlHeight	查询	可选	仅在 `msgType=html` 时生效，HTML 内容显示高度（像素），默认 `200`

示例

request & response

GET /JohnDoe/系统通知/<b>有新消息</b>?msgType=html&htmlHeight=300&url=https://example.com
───────────────  RESPONSE  ───────────────
{
  "status": 200,
  "message": "推送成功"
}

Markdown 示例推荐 POST text/plain

Markdown 含大量换行与特殊字符，放进 GET 路径需逐字 URL 编码、十分繁琐。推荐使用 POST 的 text/plain 格式，请求体即为 Markdown 原文，无需编码。

text/plain · 无需编码

POST /JohnDoe/部署通知?msgType=markdown HTTP/1.1
Host: api.chuckfang.com
Content-Type: text/plain

## 构建成功 ✅
- 服务：**api**
- 耗时：`42s`
[查看详情](https://example.com)

POST请求

支持格式

application/json
text/plain
multipart/form-data
application/x-www-form-urlencoded

表单格式

x-www-form-urlencoded

POST /{昵称}/[title] HTTP/1.1
Content-Type: application/x-www-form-urlencoded

title=可选标题&msg=必填内容&url=可选链接&msgType=html&htmlHeight=400

纯文本格式

text/plain

POST /{昵称}/[title] HTTP/1.1
Content-Type: text/plain

这里放置消息内容

JSON 示例

application/json

POST /JohnDoe?msgType=html&htmlHeight=350 HTTP/1.1
Host: api.chuckfang.com
Content-Type: application/json

{
  "title": "系统通知",
  "msg": "<p><b>欢迎使用</b>，这是 <i>HTML</i> 格式的消息</p>",
  "url": "https://example.com",
  "imgUrl": "https://example.com/icon_216x216.png"
}
───────────────  RESPONSE  ───────────────
{
  "status": 200,
  "message": "推送成功"
}

公共参数说明

参数	类型	说明
url	`String`	同时支持查询参数和 Body 参数
imgUrl	`String`	通知图标 URL，同时支持查询参数和 Body 参数（Body 优先）。建议格式 216×216、`PNG`
title	`String`	按以下顺序获取：Body 参数 > 路径参数 > 默认 MeoW
msgType	`String`	请求参数。`text`（默认，纯文本）、`html`（在 App 中渲染 HTML）、`markdown`（在 App 中渲染 Markdown）
htmlHeight	`Number`	请求参数。仅在 `msgType=html` 时生效，HTML 消息显示高度（像素），默认 `200`

响应格式

response schema

{
  "status": 状态码,
  "msg": "结果描述"
}

状态码说明

200

操作成功

400

参数错误

500

服务器错误

通用说明

所有中文参数需要进行 URL 编码。
POST 请求路径参数为可选，示例：POST /JohnDoe/自定义标题。
当同时存在路径 title 和 Body title 时，优先使用 Body 中的字段。
msgType 与 htmlHeight 都是请求参数，不属于 JSON 参数。
当 msgType=html 时，App 将解析并渲染消息内容为 HTML 格式。
当 msgType=markdown 时，App 将解析并渲染消息内容为 Markdown 格式；因 Markdown 含较多换行与特殊字符，推荐使用 POST text/plain 传递原文，避免繁琐的 URL 编码。
htmlHeight 仅在 msgType=html 时生效，不填时默认值为 200。
imgUrl 用于自定义通知图标，建议使用 216×216 的 PNG 图片；GET 与 POST 各格式均支持，POST 时 Body 中的 imgUrl 优先于查询参数。