接口文档

通过 HTTP 请求即可向 PushMe 发送消息,兼容企业微信/钉钉/飞书机器人格式

接口地址
https://push.i-i.me
请求方式
GET 或 POST
自建服务
https://您服务器:3010 [文档]
仓库地址

请求参数

参数 描述 必填
push_key 接口密钥;在app上获取,使用temp_key时则不填
title 消息标题;title和content至少填一项
content 消息内容;title和content至少填一项
date 消息时间;格式为"YYYY-mm-dd HH:ii:ss",默认为当前日期时间
type 消息类型;默认为"text"
temp_key 临时密钥new在app上获取
提示:所有参数值类型都为string字符串

消息类型(type)

text 通知消息
普通文本消息
hello world !
markdown 通知消息
markdown格式文本消息,链接支持APP内打开(需设置开启)
## hello world !
html 通知消息
html格式消息,支持css样式和js运行(js需设置开启)
<div style="border:10px solid #46bc99;...">HTML</div>
url 通知消息
URL链接消息,点击打开指定网址
https://push.i-i.me
data 数据消息
普通数据消息,建议写一个纯数字
999
markdata 数据消息
markdown格式数据消息
> 在线人数:100\n> 新用户数:10
chart 数据消息
图表消息,支持bar/line/pie,详见下方格式说明
line|5::888,999
echarts 数据消息
echarts图表,内容为option参数的json字符串
{"series":[{"type":"pie","data":[...]}]}
svg 数据消息
SVG图片消息,内容为完整的SVG代码
<svg xmlns="...">...</svg>
chart 格式说明
格式:类型|长度::value|label,value|label...
  • 类型:支持 bar、line、pie 三种,默认 bar
  • 长度:客户端保留的数据个数,默认10。无label时遵循先进先出原则
  • value:整型或float类型数值
  • label:数据标签,支持emoji,可省略
  • | , :: 为分割符,左右有一边为空时请省略
chart 示例
  • 999 — bar类型,长度10,数据999
  • 5::888 — bar类型,长度5,数据888
  • line|5::888,999 — line类型,长度5,两个数据
  • pie|5::888|A,999|B — pie类型,带标签A和B
注意:

消息主题([主题]title)

主题 标识 描述 示例(title)
info [i] 信息 [i]收到一条信息
success [s] 成功 [s]任务执行成功
warning [w] 警告 [w]服务器cpu告警
failure [f] 失败 [f]网站签到失败
提示:消息主题在消息 title 最前面 添加主题标识符实现,无需额外字段。

消息分组及头像([#分组!头像])

方法 描述 示例(title) 头像
仅设置分组 头像取分组名字首个字符 [#PushMe]hello P
分组+emoji 头像为emoji表情 [#PushMe!😄]hello 😄
分组+文字 头像为文字,最多9个字符 hello[#PushMe!百度网] 百度网
分组+图片网址 图片网址以http/https开头 hello[#PushMe!http地址] 图片
提示:头像必须配合分组使用,单独设置头像无效。格式为 [#分组!头像],位置可放在 title 任意位置。APP 支持将无分组消息合并为空分组,并支持分组消息置顶。

消息通道([~通道])

格式为 [~通道名字],通道名字支持中文。不同通道可设置不同的声音、震动、灯光等提示方式。

接口返回

返回值 描述
success 发送成功
非"success"字符串 发送失败的原因
json字符串 兼容企微/钉钉/飞书接口模式时,返回对应json结果