Skip to content

Latest commit

 

History

History
92 lines (74 loc) · 2.07 KB

internal_proto_zh.textile

File metadata and controls

92 lines (74 loc) · 2.07 KB

Terry-Mao/gopush-cluster Web http协议文档

Web内部接口文档,用于推送、删除消息等

接口汇总

接口名 URL 访问方式
推送单个私信 /1/admin/push/private POST
推送多个私信 /1/admin/push/mprivate POST
清理消息 /1/admin/msg/del POST

公共返回码

错误码 描述
0 成功
65534 参数错误
65535 内部错误

基本返回结构

{
    "ret": 0,  //错误码
    "data": {….}//如果有数据返回,则有data,无数据返回就只有前面的ret
}

推送单个私信

  • 请求参数
参数 类型 描述
key string 订阅key
expire int64 消息过期时间,单位:秒(s)
注: 消息体存放到body中,且内容必须为json格式,以上参数为URL参数.
  • 返回码
错误码 描述
1001 没有找到comet节点
{
    "ret": 0
}

推送多个私信

  • 请求参数
参数 类型 描述
expire int64 消息过期时间,单位:秒(s)
推送消息json结构如下:
{
    "m": "{\"test\":1}",
    "k": "t1,t2,t3"
}
参数 类型 描述
m string 要推送的消息体,必须为json字符串
k string 要推送的订阅key,用逗号分割
  • 返回码
错误码 描述
1001 没有找到comet节点
{
    "data": {
        "fk": [ //如果有部分key推送失败,则返回在这里,ret依然为0.fk字段结构为字符串数组。正常情况下不会有fk。
            "t1",
            "t2"
        ]
    },
    "ret": 0
}

清理消息

注:清理单个订阅(key)下的所有消息,并从Comet模块中清理掉Key对应的Channel

  • 请求参数
参数 类型 描述
key string 客户端订阅时的key
{
    "ret": 0
}