API Reference
推送 API 文档
支持离线推送。接口使用 SSL/TLS（HTTPS），可向个人客户端或频道关注者发送通知。
向一个已注册的客户端发送通知。表单、JSON、GET 三种入口能力相同。
POST接口地址（表单格式）
POST
参数multipart/form-data
| 参数 | 是否必须 | 说明 |
|---|---|---|
| title | 是 | 推送标题 |
| msg | 是 | 推送内容 |
| url | 可选 | 点击通知跳转的链接 |
| token | 是 | 要接收消息的客户端注册的token |
| issecure | 是 | 固定值：0 |
| msgType | 可选 | 消息类型，0：频道消息 1：个人信息 2：其他信息，默认值：1 |
| icon | 可选 | 【支持安卓、鸿蒙、苹果】通知图标，必须是https协议的网络地址图片 请注意： 安卓系统，在线推送显示图标支持所有品牌手机，离线推送显示图标只支持华为和荣耀 鸿蒙系统，网络图片大小不能大于192KB，否则不显示 |
| sender | 可选 | 发送者，默认：匿名消息，会在【接收消息】列表中显示 |
示例格式
请求multipart/form-data
POST /push/api/v1/sendMsg_New.php HTTP/1.1 Host: www.ggsuper.com.cn Content-Type: multipart/form-data title=推送标题 msg=推送内容 url=可选跳转链接 token=接收端的Token issecure=0 sender=发送者
返回成功
{
"code": "80000000",
"msg": "Success"
}
POST接口地址（JSON格式）
POST
参数application/json
| 参数 | 是否必须 | 说明 |
|---|---|---|
| title | 是 | 推送标题 |
| msg | 是 | 推送内容 |
| url | 可选 | 点击通知跳转的链接 |
| token | 是 | 要接收消息的客户端注册的token |
| issecure | 是 | 固定值：0 |
| msgType | 可选 | 消息类型，0：频道消息 1：个人信息 2：其他信息，默认值：1 |
| icon | 可选 | 【支持安卓、鸿蒙、苹果】通知图标，必须是https协议的网络地址图片 请注意： 安卓系统，在线推送显示图标支持所有品牌手机，离线推送显示图标只支持华为和荣耀 鸿蒙系统，网络图片大小不能大于192KB，否则不显示 |
| sender | 可选 | 发送者，默认：匿名消息，会在【接收消息】列表中显示 |
示例格式
请求application/json
POST /push/api/v1/sendMsg3_New.php HTTP/1.1
Host: www.ggsuper.com.cn
Content-Type: application/json
{
"title": "推送标题",
"msg": "推送内容",
"url": "可选跳转链接",
"token": "接收端Token",
"issecure": 0,
"sender": "发送者"
}
返回成功
{
"code": "80000000",
"msg": "Success"
}
GET接口地址
GET
参数Query · 需 URL 编码
| 参数 | 是否必须 | 说明 |
|---|---|---|
| title | 是 | 推送标题（需URL编码） |
| msg | 是 | 推送内容（需URL编码） |
| url | 可选 | 点击通知跳转的链接（需URL编码） |
| token | 是 | 要接收消息的客户端注册的token（需URL编码） |
| issecure | 是 | 固定值：0 |
| msgType | 可选 | 消息类型，0：频道消息 1：个人信息 2：其他信息，默认值：1 |
| icon | 可选 | 【支持安卓、鸿蒙、苹果】通知图标，必须是https协议的网络地址图片（需URL编码） 请注意： 安卓系统，在线推送显示图标支持所有品牌手机，离线推送显示图标只支持华为和荣耀 鸿蒙系统，网络图片大小不能大于192KB，否则不显示 |
| sender | 可选 | 发送者，默认：匿名消息，会在【接收消息】列表中显示（需URL编码） |
示例格式
请求Query
GET /push/api/v1/sendMsg2_New.php HTTP/1.1 Host: www.ggsuper.com.cn title=推送标题 msg=推送内容 url=可选跳转链接 token=接收端的Token issecure=0 sender=发送者
返回成功
{
"code": "80000000",
"msg": "Success"
}
错误代码对照表
0发送失败，网络原因或无效数据
200token错误或者失效
300请求过于频繁，普通用户1小时内最多接收3次消息
400接收消息对象当天次数已用完
500已被对方拉黑，消息无法发出！
1000风控系统检测到你有异常行为，已被封号，有问题请联系客服企业微信！
POST接口地址（JSON格式，向关注频道的人推送）
POST
参数application/json
| 参数 | 是否必须 | 说明 |
|---|---|---|
| title | 是 | 推送标题 |
| msg | 是 | 推送内容 |
| url | 可选 | 点击通知跳转的链接 |
| token | 是 | 频道创建人的token |
| channel_id | 是 | 频道的channelID，可在我的频道中查看 |
示例格式
请求application/json
POST /push/api/v1/sendChannelMsg2_New.php HTTP/1.1
Host: www.ggsuper.com.cn
Content-Type: application/json
{
"title": "推送标题",
"msg": "推送内容",
"url": "可选跳转链接",
"token": "频道创建人的Token",
"channel_id": "1"
}
返回成功
{
"code": "80000000",
"msg": "Success"
}
错误代码对照表
0发送失败，网络原因或无效数据
100每个频道每3秒只能发送一次推送