一封传话推送工具API文档

一封传话推送工具API文档

前言

【一封传话】是一款聚合推送工具,提供微信公众号、飞书、钉钉、企业微信群机器人、企微通知应用、邮件、自定义Webhook消息推送API。主要API只有一个,必传参数也只有一个,因此没有使用门槛,如果不想去查询是否推送成功,只看消息推送接口即可。

消息推送接口

  • 请求地址:https://www.phprm.com/service...
  • 请求URL上的xxxxxxxxxxxxxxxx, 是您创建消息通道的通道码
  • 请求方式:GET建议对参数进行urlencode编码, POST方式请求头,Content-Type: application/json
参数名称是否必填默认值说明
head消息标题, 长度200以内
body消息内容, 长度50000以内, 支持markdown格式, 请参考markdown语法
delayMilliseconds0延迟推送毫秒数, 最大不超过45天
url不填将使用官方网址进行预览, 填写后将跳转到自定义网址, 例如: https://weibo.com

GET请求方式样例:

https://www.phprm.com/services/push/send/xxxxxxxxxxxxxxxx?head=默认标题&body=默认内容

消息推送接口响应内容样例:

{
    "code": 0,
    "message": "请求成功",
    "data": {
        "messageIdList": [
            "1195026147680247809"
        ]
    }
}

参数说明

仅head参数必传,长度200个字符长度以内。

如果有延迟推送的需求,可以试试delayMilliseconds,如果有按年月日周期推送的需求,可以查看移动端官网。

如果您传递了url参数可以使用您个人博客或者公司网页进行预览消息,也可以使用markdown语法在body参数中嵌入网址。

body参数支持Markdown语法和emoji表情,移动端渲染效果很棒,例如公告类型消息的markdown模板如下:

# [点击查看公告](https://www.phprm.com/push/h5/)
邀请好友关注推送公众号【一封传话】。

![](https://www.phprm.com/push/h5/static/image/h5.png)

[免费公告推送H5页面](https://www.phprm.com/push/h5/)

[PC推送官网文档: http://push.phprm.com/doc/#/](http://push.phprm.com/doc/#/)

代码参考

<?php
echo file_get_contents("https://www.phprm.com/services/push/trigger/4d2dac865118761a14d10d7d3afe7c35?head=".urlencode("Markdown测试")."&body=".urlencode("# [点击查看公告](https://www.phprm.com/push/h5/)
邀请好友关注推送公众号【一封传话】。

![](https://www.phprm.com/push/h5/static/image/h5.png)

[免费公告推送H5页面:https://www.phprm.com/push/h5/](https://www.phprm.com/push/h5/)

[PC推送官网文档: http://push.phprm.com/doc/#/](http://push.phprm.com/doc/#/)"));
?>

实际上只有一行代码, 只是为了渲染出如下效果(手机端体验最佳)才使用Markdown字符串作为body的参数:

消息预览页面

Tips:传递url参数将自动跳转您个人/公司的网页,未传递url参数时【一封传话】将为您渲染Markdown图文预览页面。

在线调试与日志

Tips:官网首页支持在线测试,无需编写任何代码即可推送到微信上。

在线调试推送接口

消息查询接口

  • 请求地址:https://www.phprm.com/service...
  • 请求URL上的xxxxxxxxxxxxxxxx, 是您创建消息通道的通道码
  • 请求方式:?messageIds=1205957302260228096。如果有多个消息ID请使用英文,分隔传参。
参数名称是否必填默认值说明
messageIds最多支持5个消息ID查询

GET请求方式样例:

https://www.phprm.com/services/push/sendMessageResult/xxxxxxxxxxxxxxxx?messageIds=1205957302260228096,1205957305749889024

消息查询接口响应内容样例:

{
    "code": 0,
    "message": "请求成功",
    "data": {
        "1205957302260228096": {
            "messageId": "1205957302260228096",
            "pushTypeDesc": "官方邮件",
            "pushCount": 1,
            "viewCount": "0",
            "triggerTimeList": ["2023-02-10 19:23:46"],
            "handleTimeList": ["2023-02-10 19:23:49"],
            "readTimeList": [null],
            "handleCodeList": ["0"],
            "handleMsgList": [null]
        },
        "1205957305749889024": {
            "messageId": "1205957305749889024",
            "pushTypeDesc": "微信公众号",
            "pushCount": 1,
            "viewCount": "0",
            "triggerTimeList": ["2023-02-10 19:23:47"],
            "handleTimeList": ["2023-02-10 19:23:48"],
            "readTimeList": [null],
            "handleCodeList": ["0"],
            "handleMsgList": [null]
        }
    }
}

在线查询消息推送情况

Tips:官网首页点击发送按钮后会自动填充到查询参数框,如果是从日志页面复制的消息ID也可以到这里查询。

在线查询消息推送情况

尾声

【一封传话】是一个集成了微信、企业微信、钉钉、飞书、邮件、webhook等聚合消息推送平台。只需要调用简单的API,即可帮您迅速完成消息的推送。

当您采集别人网站的公告然后推送到自己的手机上,及时关注您想要知道的信息,手机端管理非常方便。

参考:

http://push.phprm.com/

http://push.phprm.com/doc/#/p/send

http://push.phprm.com/doc/#/p/demo

https://www.phprm.com/push/h5/


专注于消息推送领域,提供极简API,一行代码即可帮您迅速完成消息的推送。

9 声望
3 粉丝
0 条评论
推荐阅读
一封传话一对多推送实现步骤
但是我们希望实现:1. 群组订阅功能:例如我和我的好友一起加入通道后,只推送一次我们两个人都能收到消息。2. 多端提醒功能:例如我希望同时推送到微信和钉钉,如果还能推送到飞书更好了。

一封传话3阅读 545

性能的极致,Rust的加持,Zed-Dev编辑器快速搭建Python3.10开发环境
快就一个字,甚至比以快著称于世的Sublime 4编辑器都快,这就是Zed.dev编辑器。其底层由 Rust 编写,比基于Electron技术微软开源的编辑器VSCode快一倍有余,性能上无出其右,同时支持多人编辑代码。

刘悦的技术博客阅读 914

封面图
【紧急】微信存在图片闪退漏洞
已经很久没在社区发帖了,考虑到今晚很多普通用户,当然也有程序员朋友中招,因此简单聊聊。因为是技术社区,没有正式安全报告那么严谨,因此排版简单,字数不多,希望你能看懂。

瞿小凯阅读 822

封面图
【红隼书签】自定义光影、自定义背景、亮度和主题功能
👉👉👉【红隼书签】是一款简洁的在线书签导航网站。 名字的由来其实是,本着保护动物,爱护动物的初心,想到起一个鸟类的名称,其实最开始想了很多名字,小詹书签,麻雀书签等。

叫我詹躲躲阅读 496

封面图
Unity 2022 + Android 接入微信登录
实现Unity接入安卓端的微信登录分为五个大步骤生成keystore安卓应用开发者签名在微信开放平台申请移动应用接入编写Java Android部分代码, 生成arr文件编写 Unity C# 代码Unity打apk包, 安装到手机中进行测试建议...

镇远阅读 411

极光笔记 | 让运营“从心”出发,打造身临其境的客户体验!
在数字化时代,用户对于个性化、实时和多元化的互动体验需求越来越高。作为中国领先的客户互动和营销科技服务商,极光一直致力于满足客户不断变化的需求。现在,我们很高兴宣布,极光推送富媒体功能全新改造升级...

极光JIGUANG阅读 367

封面图
想快速入门性能测试?试试RunnerGo!
当前性能测试已经是一名软件测试工程师必须要了解、甚至熟练使用的一项技能。在工作时可能每次发版都要跑一遍性能,跑一遍自动化。性能测试入门容易,深入则需要太多的知识量,今天这篇文章给大家带来:怎么入门...

大雨治水阅读 366

专注于消息推送领域,提供极简API,一行代码即可帮您迅速完成消息的推送。

9 声望
3 粉丝
宣传栏