仓库地址


Github:https://github.com/yafoo/pushme
Gitee:https://gitee.com/yafu/pushme

接口地址


请求方式


请求参数

参数描述必填
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)

类型属性描述示例(content)
text通知消息普通文本消息hello world !
markdown通知消息markdown格式文本消息## hello world !
html通知消息html格式消息<div style="border: 10px solid #46bc99; text-align: center; font-size: 30px;">HTML</div>
data数据消息普通数据消息,建议写一个纯数字999
markdata数据消息markdown格式数据消息> 在线人数:100\n> 新用户数:10
chart数据消息图表消息,格式见下面说明999
echarts数据消息echarts图表{"series":[{"type":"pie","data":[{"value":81,"name":"A"},{"value":55,"name":"B"},{"value":49,"name":"C"}]}]}
  1. 各类型说明:
  2. 数据消息以title作为唯一标识,同一标识只显示一个模块,内容为最后一次推送的内容
  3. markdown消息内链接支持APP内打开,需要在设置里开启
  4. html消息支持css样式,支持运行js,运行js需要在设置里开启
    1. html消息如果不含body标签,系统会自动添加body标签,并添加一些基础样式,安卓端会自动适配暗黑模式
    2. html消息如果包含body标签,系统不做处理
    3. 在电脑端body标签不支持设置attribute属性,不支持html标签
  5. echarts消息内容为echarts图表的option参数的json字符串
  6. chart消息,格式:类型|长度::value|label,value|label...
    1. 类型支持bar、line、pie三种,默认值为bar
    2. 长度代表在客户端保留的数据个数,默认长度为10;如果数据只有value没有label,则遵循先进先出原则,有label并且客户端已有同label数据,则会替换对应值
    3. value支持整型或float类型
    4. label,数据的标签或者名字或者key,也支持emoji字符,也可省略
    5. | , :: 三个字符为分割符,属特殊字符,如果左右有一边为空,请省略分隔符
    6. 示例1:999,表示bar类型、长度10,数据999
    7. 示例2:5::888,表示bar类型、长度5,数据888
    8. 示例3:line|5::888,999,表示line类型、长度5,包含两个数据888和999
    9. 示例4:pie|5::888|A,999|B,表示pie类型、长度5,包含两个数据888和999,对应标签为A和B
提示:html和echarts消息使用webview渲染,性能会差一点。如非特殊需要,建议使用其他消息类型。数据消息不会发出状态栏通知。

消息主题([主题]title)

主题标识描述示例(title)
info[i]⬜️信息[i]收到一条信息
success[s]🟩成功[s]任务执行成功
warning[w]🟨警告[w]服务器cpu告警
failure[f]🟥失败[f]网站签到失败
提示:消息主题功能没有新增字段,而是在消息title最前面添加主题标识符实现。

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

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

消息通道(title[~通道])


消息通道格式为英文中括号+波浪符+通道名字:`[~xxxxx]`,通道名字支持中文。
注意:至少发送一条通道消息后,在手机通知设置里才能看到对应通道,这时,针对不同的通道,可以设置不同的声音、震动、灯光、桌面显示等不同的提示方式。
默认消息通道为MainChannel,默认状态通道为StateChannel,状态通道建议打开显示,方便查看服务连接状态,如不想查看,可以在PushMe左上角设置里关闭,也可以设置为异常时显示。

语音播报、重复通知


PushMe支持语音播报消息标题或内容,在PushMe设置->权限设置->通知通道,然后点开对应通道,开启语音通知。重复通知也在此开启。语音播报标题或者内容,重复通知时间间隔在PushMe设置->APP设置里配置。
提示:语音播报,需要手机安装tts引擎,一般手机默认带的有,如果没有,可以安装谷歌“Speech Recognition & Synthesis”应用或者“讯飞语记”APP,然后在安卓系统设置搜索“tts”,设置对应的语音引擎。

自建服务


插件功能


消息转发


windows客户端


接口返回


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