一封传话推送工具 API 文档
前言
【一封传话】是一款聚合推送工具,提供微信公众号、飞书、钉钉、企业微信群机器人、企微告诉利用、邮件、自定义 Webhook 音讯推送 API。次要 API 只有一个,必传参数也只有一个,因而没有应用门槛,如果不想去查问是否推送胜利,只看音讯推送接口即可。
音讯推送接口
- 申请地址:https://www.phprm.com/service…
- 申请 URL 上的 xxxxxxxxxxxxxxxx, 是您创立音讯通道的通道码
- 申请形式:GET 倡议对参数进行 urlencode 编码, POST 形式申请头,Content-Type: application/json
参数名称 | 是否必填 | 默认值 | 阐明 |
---|---|---|---|
head | 是 | 无 | 音讯题目, 长度 200 以内 |
body | 否 | 无 | 音讯内容, 长度 50000 以内, 反对 markdown 格局, 请参考 markdown 语法 |
delayMilliseconds | 否 | 0 | 提早推送毫秒数, 最大不超过 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/