Skip to content

Latest commit

 

History

History
228 lines (151 loc) · 6.55 KB

PUSH-API.md

File metadata and controls

228 lines (151 loc) · 6.55 KB
Raw

推送 API

HTTP传参方式

支持以下三种传参方式

1.HTTP GET 如 curl

#curl 例子
curl http://localhost:11001/api/test?a=1&b=2

2.HTTP POST (FORM)

#curl 例子
curl -X POST -F 'a=1' -F 'b=2' http://localhost:11001/api/test

3.HTTP POST (JSON)

#curl 例子
curl -H "Content-Type: application/json" -X POST -d '{"a":"1" , "b":"2"}' http://localhost:11001/api/test

数组类型参数

  1. string[]类型, 可以使用http标准的如 get?uid=123&uid=456   或者使用uid=["123", "456"]   至少支持一次调用传10w以上的uid  
  2. string

/api/push 应用内透传

--- 以下参数3选一,指定推送对象

  • topic -> string, 客户端调用subscribeBroadcast的参数
  • pushId -> string[] 或 string，客户端生成的随机ID
  • uid -> string[] 或 string， 通过addPushIdToUid接口绑定的uid

json -> 以下类型三选一,透传给客户端的数据,客户端会在onPush里接收到

string "test string" (如要使用其他协议,如protobuf,可以使用base64 encoded string)

json map {"uri":1, content:"test string"}

json array [1, {"content":"test string"}]

建议使用json数组,第0为表示推送类型URI, 省流量, 可通过前面几个字符判断uri，而不解析整串json

第一个int或string来表示推送类型,第二个参数表示该类型的透传数据

timeToLive -> int, 毫秒, 表示当时用户不在线, 消息服务器保存多久

当指定了uid 或者 pushId的时候可以使用tagStart,tagLessThan,tagGreaterThan进行进一步过滤

如：客户端设置了version_1.5.0的tag, 可以通过传参tagStart='version_',tagGreaterThan=1.4.0来过滤，不支持含有字母的版本号

一些特殊情况1.5.1 > 1.5, 1.5.0 > 1.5, 1.5.11 > 1.5.6, 1.6 > 1.5.1, 详细可见versionCompareTest.js

调用示例

#推送给topic=chatRoom, 数据为一串json { "message": "curl_test_message", "nickName": "curl_tester", "type": "chat_message"}
curl -H "Content-Type: application/json" -X POST -d '{"topic":"chatRoom" , "json":{ "message": "curl_test_message", "nickName": "curl_tester", "type": "chat_message"}}' http://localhost:11001/api/push

/api/notification 状态栏通知api

--- 以下参数4选一,指定推送对象

pushAll -> string, true表示推送全网,其它或者留空表示单个推送

pushId -> string[], 如 ["abc","def"] 客户端生成的随机ID,单个或者数组或string, 如 "abc"

uid -> string[],如 ["123","456"] 通过addPushIdToUid接口绑定的uid或string, 如 "123"

tag -> string, 如 "tag1", 通过客户端或者服务器接口设置的tag

timeToLive -> int, 毫秒, 表示当时用户不在线, 消息服务器保存多久 , 小米, 苹果, 华为, push-sever均支持. 可选, 默认为0

notification -> 通知消息内容 需要url encode

{
  "android" : {"title":"title1","message":"message1" },
  "apn":  {"alert": {"title":"title1","body":"message1"} , "badge":5, "sound":"default" },
  "payload": { "abc": 123}
}

notification是一个json map,内容说明如下

android - 推送给安卓手机的通知内容

apn - 通过apns推送给ios手机的通知内容

title & message - 安卓通知栏的消息标题和内容

alert(ios) - (apn对应的alert字段)消息内容

badge(ios) - (apn对应的badge字段) 可选

sound(ios) - (apn对应的sound字段) 可选

payload - 发送给应用非显示用的透传信息, 需要是一个json map

type 字符串， 可选参数，用于送达率统计查询归类

调用示例

#推送给uid 123,456两个用户
curl -H "Content-Type: application/json" -X POST -d '{"uid":["123", "456"] , "notification":{"android" : {"title":"title","message":"message" },"apn":{"alert":"message" , "badge":5, "sound":"default" },"payload":{ "abc": 123}}}' http://localhost:11001/api/notification

返回值

{ "code" : "success", "id" : "abcdefg"}

/api/uid/bind 绑定UID和pushId

http://yourip:11001/api/uid/bind?pushId=abc&uid=123&platform=ios

pushId -> string(必选),客户端生成的随机ID

uid -> string(必选),服务器需要绑定的UID

timeToLive -> int毫秒(可选), 默认 = 0, 不过期. > 0 时,表示多久客户端没连接到push-sever后, 对应关系过期

platform -> string(可选), 默认 = "default", pushId所属平台

platformLimit -> int(可选), 默认 = 0, 表示不限制. 不为0时, 表示保留多少该平台的pushId绑定关系, 优先删除最旧的绑定关系

/api/device/delete 按照pushId删除设备，除非设备重新上报pushId，以后将不会推送给此设备

http://yourip:11001/api/device/delete?pushId=abc

--- 以下参数2选一,指定推送对象

pushId -> string[], 如 ["abc","def"] 删除该pushId对应在数据库中的记录

/api/topicOnline topic在线数查询

--- 参数

topic -> 查询的topic

/api/topicDevices topic在线数查询, 包括每台设备的pushId, uid(如果有绑定)

--- 参数

topic -> 查询的topic

/api/stats/base 服务器实时状态

返回当前各个端(ios/android/browser)实时在线, 细分到每个proxy实例的在线

/api/isConnected pushId或者uid 是否在线查询

--- 参数

pushId=123 或者　uid=123

/api/stats/arrival/info 查询某条notification送达率

--- 参数

id=xxxxxx 调用notification接口时返回的id, 目前不提供华为推送查询功能

{
    "notification": "{\"message\":\"少时诵诗书所所所所所所所\",\"title\":\"ME\",\"payload\":{\"payload\":\"{\\\"msgClientId\\\":\\\"58b3c7a497e4693c887eaf82\\\",\\\"msg\\\":\\\"少时诵诗书所所所所所所所\\\",\\\"msgTime\\\":1488177060864,\\\"dataType\\\":\\\"s_op_msg\\\",\\\"startTime\\\":1488177060864}\"}}",
    "ttl": "1200000",
    "timeStart": "2/27/2017, 2:31:01 PM",
    "id": "667g7ub61Ps6",
    "timeValid": "2/27/2017, 2:51:01 PM",
    "apn": { //ios 统计
      "target": 71,
      "arrive": 71,
      "click": 0,
      "arrivalRate": "100.00%",
      "clickRate": "0.00%"
    },
    "android": { //android 统计，除去小米华为
      "target": 23,
      "arrive": 22,
      "click": 0,
      "arrivalRate": "95.65%",
      "clickRate": "0.00%"
    },
    "xiaomi": { //小米 统计
      "create_time": "2017-02-27 14:31:01",
      "invalid_target": 0,
      "raw_counter": 7,
      "click_rate": "0%",
      "delivered": 4,
      "click": 0,
      "device_condition_unmatch": 0,
      "create_timestamp": 1488177061247,
      "time_to_live": "1201s",
      "msg_type": "Topic",
      "delivery_rate": "57%",
      "id": "tcm06b40488177061247Uo",
      "resolved": 7,
      "app_not_register": 0
    }
  }