一封传话推送API文档
一封传话
2024-12-08
目录

群组提醒用户注册与自动登录SDK

提示

此SDK仅供浏览器通道使用，实时消息基于Socket.IO。消息数据本地化存储需自行实现push和pull, 填写为http(s)😕/push网址后, 每一次推送消息都会推送到你方。

# 群组提醒用户注册与自动登录SDK

http://ws.phprm.com/?channelCode=4d05f4abdb0a0c2a0269900809946903 (opens new window)

使用浏览器访问此页面, 将自动识别当前浏览器平台+版本自动注册通道成员, 自动注册成员API如下所示：

  • 请求地址：http://ws.phprm.com/api/channelMember.php
  • 请求方式：GET建议对参数进行urlencode编码
参数名称 是否必填 默认值 说明
channelCode 是 无 推送类型为“浏览器”的子通道码, 必填
appName 是 无 应用名称(首次传递将自动注册应用)
clientVersion 是 无 应用版本(后续扩展高级特性使用, 例如通过指定版本推送给部分用户)
device 是 无 群组通道成员唯一ID, 需保证业务上成员唯一
screenResolution 否 无 成员设备分辨率,如果是前端集成建议传递客户端的分辨率
userPlatformType 是 无 用户浏览器平台(成员首次传递将自动记录用户所属平台, 建议透传此参数, 如果无法获取建议传递Chrome)
userPlatformVersion 是 无 用户浏览器版本(成员首次传递将自动记录用户所属平台版本, 建议透传此参数, 如果无法获取可传递任意版本)
userUa 是 无 用户浏览器User-Agent, 建议透传此参数, 如果无法获取建议传递应用唯一标识

传递任意推送类型为“浏览器”通道码, 即可打开群组聊天窗口(免SDK集成方案: 复制并嵌入以下url即可实现成员注册), 可以按照请求如下API方式计算群组成员的专属url:

http://ws.phprm.com/api/channelMember.php?channelCode=4d05f4abdb0a0c2a0269900809946903&appName=browser&clientVersion=1.0&device=Chrome122.0.0.0&screenResolution=1920%2C1080&userPlatformType=Chrome&userPlatformVersion=122.0.0.0&userUa=mozilla%2F5.0+(windows+nt+10.0%3B+win64%3B+x64)+applewebkit%2F537.36+(khtml%2C+like+gecko)+chrome%2F122.0.0.0+safari%2F537.36
1

SDK响应内容样例：

{
    "code": 0,
    "message": "请求成功",
    "data": {
        "channelId": "1304170050458501120",
        "pushType": 1,
        "channelType": 3,
        "channelCode": "4d05f4abdb0a0c2a0269900809946903",
        "channelTypeDesc": "用户消息推送",
        "createTime": "2023-01-11 21:44:58",
        "pushTypeDesc": "浏览器",
        "channelMemberRelId": "535374628475269",
        "nickname": "Chrome",
        "avatar": "\/\/www.phprm.com\/push\/h5\/static\/avatar\/chrome.png",
        "channelName": "线报酷",
        "kfId": "KF3",
        "group": 1,
        "token": "e1ba895b0bcb25c7033652eb2622d9fe",
        "banDevice": 0
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

将device（用户唯一标识）对应的token、createTime、channelCode、uid存入数据库，在构造群组推送聊天窗口url时按照如下方式拼接：

参数名称 是否必填 默认值 说明
token 是 无 验证token, 必填
createTime 是 无 通道成员首次加入时间
channelCode 是 无 通道码(必须为类型为“浏览器”的通道码)
channelName 否 无 通道名称(可修改为自定义通道名称, 将作为聊天窗口标题展示)
uid 是 无 SDK返回的通道成员channelMemberRelId唯一ID
name 否 无 通道成员名称(可以为昵称,支持emoji)
avatar 否 无 通道成员头像(可以为自定义头像网址,如不传递将展示平台随机头像)

示例应用: 将如下网址添加到浏览器收藏夹即可快速打开“群聊”窗口（自动适配移动端）, 也可以根据以上API进行开发接入群组SDK。其中channelCode为子通道码时, 当加入成员数量超过1000人时将自动生成下一个子通道, 直到子通道数量达到1000个（总成员上限为100万）时将停止自动登录, 如需扩充请联系管理员。

http://ws.phprm.com/index/index/pc?group=1&token=e1ba895b0bcb25c7033652eb2622d9fe&createTime=2024-04-11%2021:44:58&channelCode=4d05f4abdb0a0c2a0269900809946903&channelName=%E7%BA%BF%E6%8A%A5%E9%85%B7&uid=535374628475269&name=Chrome&avatar=%2F%2Fwww.phprm.com%2Fpush%2Fh5%2Fstatic%2Favatar%2Fchrome.png
1

# 通过SDK推送消息

# 个人消息(http方式, 需自动登录获得token)

http://ws.phprm.com/api/push.php?action=send&token=0e90c59f47808f10b43dffe55a27f6ae&createTime=2024-08-28+13%3A44%3A16&channelCode=41c706340c1158520270084906e98628&toId=KF3&toName=%E4%B8%80%E5%B0%81%E4%BC%A0%E8%AF%9D&content=2222&fromName=pw27008490&fromId=584447811789701&fromAvatar=%2F%2Fwww.phprm.com%2Fpush%2Fh5%2Fstatic%2Favatar%2Fstatic0091.jpg
1
参数名称 是否必填 默认值 说明
action 是 无 发送消息默认填写:send
token 是 无 验证token, 必填, 从channelMember.php响应内容中获取
createTime 是 无 通道成员首次加入时间
channelCode 是 无 通道码
channelName 否 无 通道名称(可修改为自定义通道名称, 将作为聊天窗口标题展示)
fromId 是 无 SDK返回的通道成员channelMemberRelId唯一ID或者机器人客服:KF3
fromName 否 无 消息发送人昵称
fromAvatar 否 无 消息发送人头像

# 个人消息(websocket方式, 需自动登录获得token)

8282ws.phprm.com
1
参数名称 是否必填 默认值 说明
type 是 无 发送消息默认填写:chatMessage
token 是 无 验证token, 必填, 从channelMember.php响应内容中获取
createTime 是 无 通道成员首次加入时间
channelCode 是 无 通道码
channelName 否 无 通道名称(可修改为自定义通道名称, 将作为聊天窗口标题展示)
fromId 是 无 SDK返回的通道成员channelMemberRelId唯一ID或者机器人客服:KF3
fromName 否 无 消息发送人昵称
fromAvatar 否 无 消息发送人头像

# 推送报文

{"type":"chatMessage","data":{"token":"0e90c59f47808f10b43dffe55a27f6ae","createTime":"2024-08-28 13:44:16","channelCode":"41c706340c1158520270084906e98628","toId":"KF3","toName":"","content":"websocket","fromName":"pw27008490","fromId":"584447811789701","fromAvatar":"//www.phprm.com/push/h5/static/avatar/static0091.jpg"}}
1

# 有新消息报文(开发中)

# 群组通知消息(无需token, 默认使用系统markdown样式)

https://www.phprm.com/services/push/trigger/xxxxxxxxxxxxxxxx
1

具体参考: 提醒接口API文档。

# 通过SDK拉取指定成员历史消息

https://ws.phprm.com/api/pull.php?action=getWsLog&token=039f0a29ec441637b47b83e678c7fb6b&uid=1304170050492055552&maxId=0&createTime=2023-11-08+19%3A46%3A10&channelCode=4d05f4abdb0a0c2a0269900809946903
1
参数名称 是否必填 默认值 说明
action 是 无 拉取消息默认填写:getWsLog
token 是 无 验证token, 必填
uid 是 无 SDK返回的通道成员channelMemberRelId
name 是 无 SDK返回的通道成员名称nickname, 与uid参数一一对应
maxId 否 无 上一次最大id, 默认为0时将拉去最新10条，后续分页需将返回值中的maxId作为参数
createTime 是 无 通道成员首次加入时间
channelCode 是 无 通道码(必须为类型为“浏览器”的通道码)

# 查询报文

{"code":0,"data":{"total":"30924","data":[{"id":"613851","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 前两天 zfb 还有云闪付的河南金秋消费券抢了吗？\\n 🕒 通知时间：2024-10-13 12:57:48<\/font> \\n 📝 备注: 前两天 zfb 还有云闪付的河南金秋消费券抢了吗？ 闲鱼出了 150-50 的券 我润了 25{:拜拜:} \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427279156307222528&i=27471330&m=7da8545d649f8942)查看完整推送内容。","timeLine":"1728795468","ip":"","messageId":"1427279156307222528","messagePushId":"27471330","time":"12:57"},{"id":"613850","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 芒果TV+PLUS年卡目前还有 0点 芒果TV会员年卡+京东PLUS年卡 98 买一赠一\\n 🕒 通知时间：2024-10-13 12:57:47<\/font> \\n 📝 备注: 芒果TV+PLUS年卡目前还有 【0点】芒果TV会员年卡+京东PLUS年卡【98】 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427279151907397632&i=27471235&m=feeffdf32afc549b)查看完整推送内容。","timeLine":"1728795467","ip":"","messageId":"1427279151907397632","messagePushId":"27471235","time":"12:57"},{"id":"613843","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 妮维雅如没有福袋红包 也可以用淘宝秒杀页里弹的红包拍淘宝搜 淘宝秒杀 从页面搜宝贝标题拍\\n 🕒 通知时间：2024-10-13 12:56:53<\/font> \\n 📝 备注: 妮维雅如没有福袋红包，也可以用淘宝秒杀页里弹的红包拍 淘宝搜【淘宝秒杀】从页面搜宝贝标题拍部分账号标题下有2元福袋妮维雅 美白身体乳400ml 弹出礼金 88vip【26.97】反14卡 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427278925670834176&i=27471134&m=bc6b6f6d303e4491)查看完整推送内容。","timeLine":"1728795413","ip":"","messageId":"1427278925670834176","messagePushId":"27471134","time":"12:56"},{"id":"613839","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 淘宝 领饿了么22-11等红包 10点 11点 13点 15点 17点 先在上一场时间等\\n 🕒 通知时间：2024-10-13 12:55:56<\/font> \\n 📝 备注: 淘宝 领饿了么22-11等红包10点 11点 13点 15点 17点先在上一场时间等 倒计时1-2秒卡00准时切过去每场名额1W 可叠页面2卷-tb社群虹包可叠加22-11等 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427278684871647232&i=27471031&m=2340452899f05d8f)查看完整推送内容。","timeLine":"1728795356","ip":"","messageId":"1427278684871647232","messagePushId":"27471031","time":"12:55"},{"id":"613835","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 猫超 部分账号标题下有3元福袋 维达 芦荟精华湿厕纸80片×5包 弹出礼金 88vip\\n 🕒 通知时间：2024-10-13 12:55:37<\/font> \\n 📝 备注: 【猫超】部分账号标题下有3元福袋维达 芦荟精华湿厕纸80片×5包 弹出礼金 88vip【30.91】 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427278608866664448&i=27470929&m=c80c3f7a0a9749ae)查看完整推送内容。","timeLine":"1728795337","ip":"","messageId":"1427278608866664448","messagePushId":"27470929","time":"12:55"},{"id":"613831","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 翼支付 陪你过周末 盲盒抽0.3-1元话费券\\n 🕒 通知时间：2024-10-13 12:53:57<\/font> \\n 📝 备注: \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427278188589015040&i=27470816&m=aed809af4b7f7012)查看完整推送内容。","timeLine":"1728795237","ip":"","messageId":"1427278188589015040","messagePushId":"27470816","time":"12:53"},{"id":"613827","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 翼支付 陪你过周末 盲盒抽0.3-1元话费券\\n 🕒 通知时间：2024-10-13 12:53:55<\/font> \\n 📝 备注: \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427278177256005632&i=27470718&m=046681b56d5901be)查看完整推送内容。","timeLine":"1728795235","ip":"","messageId":"1427278177256005632","messagePushId":"27470718","time":"12:53"},{"id":"613823","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 优时颜恢复弹礼金 猫超 299-50券 部分账号标题下有2元福袋 优时颜 平衡洁面乳100g*2支\\n 🕒 通知时间：2024-10-13 12:53:37<\/font> \\n 📝 备注: 优时颜恢复弹礼金 【猫超】宝贝下299-50券部分账号标题下有2元福袋优时颜 平衡洁面乳100g*2支 弹出礼金 88vip【65.15】 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427278102341541888&i=27470612&m=8c8c6b89b2bcf0bb)查看完整推送内容。","timeLine":"1728795217","ip":"","messageId":"1427278102341541888","messagePushId":"27470612","time":"12:53"},{"id":"613820","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 猫超 199-35券 部分账号标题下有5元福袋 厨邦 零添加原汁黑豆特级生抽500mL*2瓶\\n 🕒 通知时间：2024-10-13 12:53:00<\/font> \\n 📝 备注: 【猫超】宝贝下199-35券部分账号标题下有5元福袋厨邦 零添加原汁黑豆特级生抽500mL*2瓶 凑199-35后 88vip【9.71】 凑款比如可用这个拍4件 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427277950717452288&i=27470415&m=02099171e1a2cfc6)查看完整推送内容。","timeLine":"1728795180","ip":"","messageId":"1427277950717452288","messagePushId":"27470415","time":"12:53"},{"id":"613816","fromId":"KF3","fromName":"一封传话","fromAvatar":"\/uploads\/20231021\/0553a4843d7ae1ebe557afef36a7a92c.png","toId":"1304170050492055552","toName":"创建人","status":"0","content":"【线报酷】\\n ✉️ 薇诺娜面膜今天也有弹礼金 猫超 薇诺娜 极润水柔隐形面膜6片*2盒 弹出礼金 88vip\\n 🕒 通知时间：2024-10-13 12:52:54<\/font> \\n 📝 备注: 薇诺娜面膜今天也有弹礼金 【猫超】薇诺娜 极润水柔隐形面膜6片*2盒 弹出礼金 88vip【62.9】反20卡 \\n 🔗 点[「详情」](http:\/\/push.phprm.com\/message\/view.html?t=1427277924599521280&i=27470319&m=46c67562ed2d5f4a)查看完整推送内容。","timeLine":"1728795174","ip":"","messageId":"1427277924599521280","messagePushId":"27470319","time":"12:52"}],"maxId":"613816","pages":3093},"message":""}
1

# 消息数据本地化存储

默认创建"浏览器“类型提醒或者通道, 群组成员、消息数据将托管在ws.phprm.com域下, 通过修改通道填写自定义webhook网址可实现数据本地化存储:

#API文档#群组提醒
Last Updated: 2024/12/12, 21:28:26
推送日志与图标统计
浏览器插件

← 浏览器插件→

最近更新
01
API文档
12-08
02
名词解释
12-08
03
简介
12-08
更多文章>
Theme by Vdoing | Copyright © 2024-2025

友情链接：推送API | 推送移动版

Copyright © 2024 All rights reserved Powered by phprm.com版权所有 | 京ICP备14058182号-3