Skip to content

Latest commit

 

History

History
110 lines (87 loc) · 2.45 KB

external_proto_zh.textile

File metadata and controls

110 lines (87 loc) · 2.45 KB
Raw

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

Web外部接口文档，用于获取Subcribe节点,获取离线消息等

接口汇总

接口名 URL 访问方式
获取订阅节点 /1/server/get GET
获取离线消息 /1/msg/get GET
获取初始消息ID /1/time/get GET

公共返回码

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

基本返回结构

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

如何接口需要返回jsonp结构(例如客户端使用js解析json)，则指定callback参数，例如：callback=test，则返回结构如下：

```scala
test({
“ret”: 0, //错误码
“data”: {….}//如果有数据返回，则有data，无数据返回就只有前面的ret
})
```

获取订阅节点

  • 请求参数
参数 类型 描述
k string 订阅key
p int 订阅协议 1:websocket 2:tcp
cb string 返回jsonp结构函数名(可选)
  • 返回参数说明
参数 类型 描述
server string 返回的可用于订阅的地址
  • 返回码
错误码 描述
1001 没有找到key对应的节点 
{
    "ret": 0,
    "data": {
	    "server": "127.0.0.1:8080"  //IP:Port
    }
}

获取离线消息

  • 请求参数
参数 类型 描述
k string 订阅key
m int64 最新接收的私有消息ID
cb string jsonp函数名(可选)
  • 返回参数说明
参数 类型 描述
msgs string数组 私有离线消息
注： 1.返回msgs、pmsgs消息中的参数mid类型为int64,注意长度.
  • 返回结果
{
    "data": {
        "msgs": [
            {"msg":"{\"test\":1}","mid":13999084541846408,"gid":0},
            {"msg":"{\"test\":2}","mid":13999084579056605,"gid":0}
        ]
    },
    "ret": 0
}

获取初始消息ID

  • 请求参数
参数 类型 描述
cb string 返回jsonp结构函数名(可选)
  • 返回参数说明
参数 类型 描述
timeid string 初始消息ID 
{
    "ret": 0,
    "data": {
        "timeid": 13999084541846408  //MID
    }
}