消息推送API文档

文档地址：https://www.chuckfang.com/MeoW/api_doc.html

接口地址：http://api.chuckfang.com/ 或 https://api.chuckfang.com/

请求方式

GET请求

URL格式

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

参数说明

参数位置是否必须说明
昵称路径必填用户昵称（不允许包含斜杠）
title路径可选消息标题，省略时默认使用"MeoW"
msg路径必填消息内容
url查询参数可选跳转链接（需URL编码）
msgType查询参数可选消息显示类型：text（默认，纯文本显示），html（在App中渲染HTML格式）
htmlHeight查询参数可选仅在msgType=html时生效，App中显示HTML内容的高度（单位：像素），不填时默认200

示例

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

POST请求

支持格式

表单格式

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

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

纯文本格式

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

这里放置消息内容

POST 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"
}

===
返回值：
{
  "status": 200,
  "message": "推送成功"
}

公共参数说明

参数类型说明
urlString同时支持查询参数和Body参数
titleString按以下顺序获取：Body参数 > 路径参数 > 默认MeoW
msgTypeString请求参数。消息显示类型：text（默认，纯文本显示），html（在App中渲染HTML格式）
htmlHeightNumber请求参数。仅在msgType=html时生效，App中显示HTML消息的高度（像素），不填时默认200

响应格式

{
  "status": 状态码,
  "msg": "结果描述"
}
状态码说明：
200 - 操作成功
400 - 参数错误
500 - 服务器错误

通用说明