魅族开放平台 PUSH 系统 JAVA 版本 SDK JavaPushSdk 发布说明 ( 请使用最新版本 ) 中央仓库获取 MVN Repository 或者 Central Repository 直接下载获取 Java Server SDK 更新日志 [ ]V

Transcription

1 魅族开放平台 PUSH 系统 JAVA 版本 SDK JavaPushSdk 发布 ( 请使用最新版本 ) 中央仓库获取 MVN Repository 或者 Central Repository 直接下载获取 Java Server SDK 更新日志 [ ]V _release 增加 sdk 日志配置文件 [ ]V _release 增加 pushid 开关关闭状态返回 [ ]V _release 通知栏消息聚合功能 [ ]V _release 推送 & 订阅域名解耦 [ ]V _release 通知栏 pushid alias 增加消息回执功能 [ ]V _release 开放统计 : 获取应用推送统计 ( 最长跨度 30 天 ) [ ]V _release 开放别名 标签订阅服务开放通知栏 透传消息开关 [ ]V _release fixed #12 [ ]V _release 推送结果增加 msgid 通过 msgid 以及推送目标在推送平台查询具体的推送日志明细 [ ]V _release 1/39

2 1.0.0 标准版 为优化 flyme 系统整体功耗, 推送平台决定本周五 (6 月 16 号 ) 起限制透传消息推送的使用, 不排除关闭透传推送 使用透传推送的业务请尽快切换到通知栏推送, 以避免消息推送失败 新接入的应用请使用通知栏推送受影响的及功能 : 1. pushid 透传消息推送 (pushmessage) 2. 别名透传消息推送 (pushmessagebyalias) 3. 获取 taskid 的透传推送 (gettaskid) 4. 全网透传推送 (pushtoapp) 5. 标签透传推送 (pushtotag) 6. 在平台上进行的透传推送 SDK 日志配置 本 SDK 是利用 JDK 中类 java.util.logging.logger 来记录日志, 如需 SDK 日志,classpath 中增加 flyme-pushlogger.properties 文件即可配置如下 handlers = java.util.logging.consolehandler,java.util.logging.filehandler java.util.logging.consolehandler.formatter = java.util.logging.simpleformatter java.util.logging.consolehandler.level = INFO java.util.logging.filehandler.pattern = c:/push.log%g.log java.util.logging.filehandler.formatter = java.util.logging.simpleformatter java.util.logging.filehandler.limit = java.util.logging.filehandler.count = 3 java.util.logging.filehandler.append = true java.util.logging.filehandler.level = INFO LOGGER.level = FINEST 定义 推送服务 (IFlymePush) 调用该类实例的方法来推送消息, 构造函数如下 : 必填 appsecret String 是 null 注册应用 appsecret 2/39

3 usessl Boolean 否 false 是否使用 https 调用 :true 使用 https 连接,false 使用 http 连接 订阅服务 (IFlymePushSub) 调用该类实例的方法做别名 标签 推送开关订阅服务, 构造函数如下 : 必填 appid Long 是 null 注册应用 appid appsecret String 是 null 注册应用 appsecret usessl Boolean 否 false 是否使用 https 调用 :true 使用 https 连接,false 使用 http 连接 通知栏消息体 (Message) 推送消息实体 ( 抽象类 ) 子类 VarnishedMessage UnVarnishedMessage 通知栏消息体 透传消息体 通知栏消息 (VarnishedMessage) 必 填 appid Long 是 null 注册应用 appid title String 是 null 推送标题, 字数限制 1~32 content String 是 null 推送内容, 字数限制 1~100 noticebartype int 否 0 noticeexpandtype int 否 0 通知栏样式 (0, " 标准 "),(2, " 安卓原生 ") 非必填, 值为 0 展开方式 (0, " 标准 "),(1, " 文本 ") 非必填, 值为 0 noticeexpandcontent String 否 null 展开内容, noticeexpandtype 为文本时, 必填 clicktype int 否 0 url String 否 null 点击动作 (0," 打开应用 "),(1," 打开应用页面 "),(2," 打开 URI 页面 "),(3, " 应用客户端自定义 ") 非必填, 值为 0 URI 页面地址, clicktype 为打开 URI 页面时, 必填, 长度限制 1000byte parameters JSONObject 否 null 透传参数 JSON 格式, 非必填 3/39

4 activity String 否 null customattribute String 否 null isoffline Boolean 否 true validtime int 否 24 pushtimetype int 否 0 starttime Date 否 null 应用页面地址, clicktype 为打开应用页面时, 格式 pkg.activity eg: com.meizu.upspushdemo.testactivity 必填 应用客户端自定义内容, clicktype 为应用客户端自定义时, 必填, 长度限制 1000byte 是否进离线消息, (false 否 true 是 ) 非必填, 值为 true 有效时长 (1~72 小时内的正整数 ), isoffline 值为 true 时, 必填, 值的范围 1~72 定时推送 (0, " 即时 "),(1, " 定时 "), 只对全部用户推送生效 任务定时开始时间, 非必填,pushTimeType 为 True 必填 只对全部用户推送生效 isfixspeed Boolean 否 false 是否定速推送, 非必填, 值为 False fixspeedrate Long 否 0 定速速率, isfixspeed 为 true 时, 必填 issuspend Boolean 否 true isclearnoticebar Boolean 否 true 是否通知栏悬浮窗显示 (true 显示,false 不显示 ) 非必填, True 是否可清除通知栏 (true 可以,false 不可以 ), 非必填, true isfixdisplay Boolean 否 false 是否定时展示 非必填, false fixdisplaytime (Date,Date) 否 (null,null) vibrate Boolean 否 true lights Boolean 否 true sound Boolean 否 true notifykey String 否 null 定时展示开始, 结束时间 fixdisplay 为 true 时, 必填, 并且开始时间要晚于结束时间 震动 (false 关闭 true 开启 ), 非必填, true 闪光 (false 关闭 true 开启 ), 非必填, true 声音 (false 关闭 true 开启 ), 非必填, true 分组合并推送的 key, 凡是带有此 key 的通知栏消息只会显示最后到达的一条 由数字 ([0-9]), 大小写字母 ([a-za-z]), 下划线 (_) 和中划线 (-) 组成, 长度不大于 8 个字符 extra Map<String, String> 否 null 回执参数 (ExtraParam) 透传消息 (UnVarnishedMessage) 4/39

5 必 填 默 认 appid Long 是 null 注册应用 appid title String 否 null 推送标题, 任务推送建议填写, 方便数据查询, 字数限制 1~32 content String 是 null 推送内容, 必填, 字数限制 3800byte 以内 isoffline Boolean 否 true 是否进离线消息, 非必填, 为 true validtime int 否 24 有效时长 (1~72 小时内的正整数 ), isoffline 值为 true 时, 必填, 值的范围 pushtimetype int 否 0 定时推送 (0, " 即时 "),(1, " 定时 "), 只对全部用户推送生效 starttime Date 否 null 任务定时开始时间, pushtimetype 为 1 必填 只对全部用户推 送生效 isfixspeed Boolean 否 false 是否定速推送, 非必填, 值为 false fixspeedrate Long 否 0 定速速率 isfixspeed 为 true 时, 必填 (ResultPack) 方法名称 code() String 响应码 Comment() String 响应 value() T 响应内容 errorcode() Enum 响应异常枚举详见 ErrorCode 消息推送结果 (PushResult) 方法名称 getmsgid() String 推送消息 ID, 用于推送流程明细排查 getresptarget() Map 推送目标结果状态 (KEY: 推送响应码 VALUE: 响应码对应的目标用户 ) 响应码定义 (ErrorCode) 名称 Code Commen UNKNOWN_ERROR -1 未知错误 SUCCESS 200 成功 SYSTEM_ERROR 1001 系统错误 SYSTEM_BUSY 1003 服务器忙 5/39

6 PARAMETER_ERROR 1005 参数错误, 请参考 API 文档 INVALID_SIGN 1006 签名认证失败 INVALID_APPLICATION_ID appid 不合法 INVALID_APPLICATION_KEY appkey 不合法 UNSUBSCRIBE_PUSHID pushid 未注册 INVALID_PUSHID pushid 非法 PARAM_BLANK 参数不能为空 APP_IN_BLACK_LIST 应用被加入黑名单 APP_REQUEST_EXCEED_LIMIT 应用请求频率过快 APP_PUSH_TIME_EXCEED_LIMIT 超过该应用的次数限制 APP_REQUEST_PUSH_LIMIT 超过该应用每天推送次数限制 INVALID_APPLICATION_PACKAGENAME packagename 不合法 INVALID_TASK_ID 非法的 taskid INVALID_APPLICATION_SECRET 非法的 appsecret DIRECT_OUT_LIMIT 透传超过限制 推送响应码定义 (PushResponseCode) 名称 Code Commen RSP_NO_AUT 201 没有权限, 服务器主动拒绝 RSP_DB_ERROR 501 推送消息失败 (db_error) RSP_INTERNAL_ERROR 513 推送消息失败 RSP_SPEED_LIMIT 518 推送超过配置的速率 RSP_OVERFLOW 519 推送消息失败服务过载 RSP_REPEATED 520 消息折叠 (1 分钟内同一设备同一应用消息收到多 次, 5 次 ) RSP_UNSUBSCRIBE_PUSHID pushid 失效 (pushid 未订阅 ) RSP_INVALID_PUSHID pushid 非法 RSP_UNSUBSCRIBE_ALIAS 别名未订阅 ( 包括推送开关关闭的设备 ) RSP_OFF_PUSHID pushid 失效 ( 消息开关关闭 ) 推送 (PushType) 6/39

7 枚举 STATUSBAR Enum 通知栏消息 DIRECT Enum 透传消息 推送标签集合 (ScopeType) 枚举 UNION Enum 并集 INTERSECTION Enum 交集 任务推送统计 (TaskStatistics) 名称 targetno Long 目标数 validno Long 有效数 pushedno Long 推送数 acceptno Long 接受数 displayno Long 展示数 clickno Long 点击数 任务推送统计 ( 天 )(DailyPushStatics) 名称 date Date 日期 targetno Long 目标数 validno Long 有效数 pushedno Long 推送数 acceptno Long 接受数 displayno Long 展示数 clickno Long 点击数 订阅别名信息 (AliasInfo) 名称 pushid String 订阅 pushid 7/39

8 alias String 订阅别名 订阅标签信息 (TagInfo) 名称 pushid String 订阅 pushid tags List 订阅标签 订阅开关状态 (SwitchStatusInfo) 名称 pushid String 订阅 pushid statusbarswitch boolean 通知栏开关状态 directswitch boolean 透传开关状态 回执 (CallBackType) 枚举 RECEIVE Enum 送达回执 CLICK Enum 点击回执 RECEIVE_CLICK Enum 送达与点击回执 回执参数 (ExtraParam) 枚举 CALLBACK Enum 回执 ( 第三方接收回执的 Http, 最大长度 128 字节 ) CALLBACK_PARAM Enum 回执参数 ( 第三方自定义回执参数, 最大长度 64 字节 ) CALLBACK_TYPE Enum 回执 ((1- 送达回执, 2- 点击回执, 3- 送达与点击回执 ), 3) 非任务推送 向指定的 pushid 推送消息 注 : 推送平台使用 pushid 来标识每个独立的用户, 每一台终端上每一个 app 拥有一个独立的 pushid 8/39

9 应用场景 场景 1: 查找手机业务需要远程定位位置, 可发送消息指令到对应的设备 场景 2: 社区用户回帖消息提醒, 用户对发表的帖子有最新回复时, 消息提醒发帖者 pushid 通知栏消息推送 (pushmessage) ResultPack<PushResult> pushmessage(varnishedmessage message, List<String> pushids) ResultPack<PushResult> pushmessage(varnishedmessage message, List<String> pushids, int retries) 推送通知栏 消息 推送通知栏 消息 参数 message VarnishedMessage 是 null 推送消息 pushids List 是 null 推送目标, 一批最多不能超过 1000 个 retries int 否 0 超时 or 异常重试次数 PushResult msgid; 推送消息 ID, 用于推送流程明细排查 resptarget; 推送目标结果状态 (key: 推送响应码 value: 响应码对应的目标用户 ) 注 : 只返回不合法 超速以及推送失败的目标用户, 业务一般对超速的 pushid 处理 /** * 通知栏消息推送 (pushmessage) Exception */ public void testvarnishedmessagepush() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); 9/39

10 // 组装消息 VarnishedMessage message = new VarnishedMessage.Builder().appId(appId).title("Java SDK 推送标题 ").content("java SDK 推送内容 ").noticeexpandtype(1).noticeexpandcontent(" 展开文本内容 ").clicktype(2).url(" {\"k1\":\"value1\",\"k2\":0,\"k3\":\"value3\"")).offline(true).validtime(12).suspend(true).clearnoticebar(true).vibrate(true).lights(true).sound(true).build(); // 目标用户 List<String> pushids = new ArrayList<String>(); pushids.add("pushid_1"); pushids.add("pushid_2"); // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessage(message, pushids); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co de())) { //TODO 5 业务处理, 重推... 10/39

11 System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); pushid 透传消息推送 (pushmessage) ResultPack<PushResult> pushmessage(unvarnishedmessage message, List<String> pushids) ResultPack<PushResult> pushmessage(unvarnishedmessage message, List<String> pushids, int retries) 推送透传 消息 推送透传 消息 参数 message UnVarnishedMessage 是 null 推送消息 pushids List 是 null 推送目标, 一批最多不能超过 1000 个 retries int 否 0 超时 or 异常重试次数 PushResult msgid; 推送消息 ID, 用于推送流程明细排查 resptarget; 推送目标结果状态 (key: 推送响应码 value: 响应码对应的目标用户 ) 注 : 只返回不合法 超速以及推送失败的目标用户, 业务一般对超速的 pushid 处理 /** * 透传消息推送 (pushmessage) Exception */ public void testunvarnishedmessagepush() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装透传消息 UnVarnishedMessage message = new UnVarnishedMessage.Builder().appId(appId) 11/39

12 .title("java SDK 透传推送标题 ").content("java Sdk 透传推送内容 ").isoffline(true).validtime(10).build(); // 目标用户 List<String> pushids = new ArrayList<String>(); pushids.add("pushid_1"); pushids.add("pushid_2"); // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessage(message, pushids); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co de())) { //TODO 5 业务处理, 重推... System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); 12/39

13 别名通知栏消息推送 (pushmessagebyalias) ResultPack<PushResult> pushmessagebyalias(varnishedmessage message, List<String> alias) ResultPack<PushResult> pushmessagebyalias(varnishedmessage message, List<String> alias, int retries) 推送通知 栏消息 推送通知 栏消息 参数 message VarnishedMessage 是 null 推送消息 alias List 是 null 推送目标, 一批最多不能超过 1000 个 retries int 否 0 超时 or 异常重试次数 PushResult msgid; 推送消息 ID, 用于推送流程明细排查 resptarget; 推送目标结果状态 (key: 推送响应码 value: 响应码对应的目标用户 ) 注 : 只返回不合法 超速以及推送失败的目标用户 /** * 别名通知栏消息推送 (pushmessage) * Exception */ public void testvarnishedmessagepushbyalias() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装消息 VarnishedMessage message = new VarnishedMessage.Builder().appId(appId).title("Java SDK 推送标题 ").content("java SDK 推送内容 ").noticeexpandtype(1).noticeexpandcontent(" 展开文本内容 ").clicktype(2).url(" 13/39

14 {\"k1\":\"value1\",\"k2\":0,\"k3\":\"value3\"")).offline(true).validtime(12).isfixdisplay(true).fixdisplaytime(str2date(" :00:00"), str2date(" :30:00")).suspend(true).clearNoticeBar(true).vibrate(true).lights(true).sound(true).build(); // 目标用户 List<String> alias = new ArrayList<String>(); alias.add("android"); alias.add("alias2"); // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessagebyalias(message, alias); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co de())) { //TODO 5 业务处理, 重推... System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); 14/39

15 别名透传消息推送 (pushmessagebyalias) ResultPack<PushResult> pushmessagebyalias(unvarnishedmessage message, List<String> alias) ResultPack<PushResult> pushmessagebyalias(unvarnishedmessage message, List<String> alias, int retries) 推送透传 消息 推送透传 消息 参数 message UnVarnishedMessage 是 null 推送消息 alias List 是 null 推送目标, 一批最多不能超过 1000 个 retries int 否 0 超时 or 异常重试次数 PushResult msgid; 推送消息 ID, 用于推送流程明细排查 resptarget; 推送目标结果状态 (key: 推送响应码 value: 响应码对应的目标用户 ) 注 : 只返回不合法 超速以及推送失败的目标用户 /** * 别名透传推送 * Exception */ public void testunvarnishedmessagepushbyalias() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装透传消息 UnVarnishedMessage message = new UnVarnishedMessage.Builder().appId(appId).title("Java SDK 透传推送标题 ").content("java Sdk 透传推送内容 ").build(); 15/39

16 // 目标用户 List<String> alias = new ArrayList<String>(); alias.add("alias"); alias.add("alias2"); // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessagebyalias(message, alias); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co de())) { //TODO 5 业务处理, 重推... System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); 任务推送 16/39

17 首先获取推送的 taskid, 然后通过 taskid 向指定的 pushid 推送消息 应用场景 浏览器对指定的某一大批量 pushid 用户推送活动或者新闻消息, 通过先获取 taskid, 然后通过 taskid 批量 推送, 推送过程中可以根据 taskid 时时获取推送统计结果 获取推送 taskid(gettaskid) ResultPack gettaskid(pushtype pushtype, Message message) 获取推送 taskid 参数 pushtype PushType 是 null 消息 message Message 是 null 消息体 Long 任务 ID /** * 获取通知栏推送 taskid(gettaskid) Exception */ public void testgetvarnishedmessagetaskid() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装消息 VarnishedMessage message = new VarnishedMessage.Builder().appId(appId).title("java Sdk 推送标题 ").content("java Sdk 推送内容 ").noticeexpandtype(1).noticeexpandcontent(" 展开文本内容 ").clicktype(2).url(" {\"k1\":\"value1\",\"k2\":0,\"k3\":\"value3\"")) 17/39

18 .offline(true).validtime(12).suspend(true).clearnoticebar(true).vibrate(false).lights(false).sound(false).fixspeed(true).fixspeedrate(20).build(); ResultPack<Long> result = push.gettaskid(pushtype.statusbar, message); System.out.println(result); /** * 获取透传推送 taskid(gettaskid) Exception */ public void testgetunvarnishedmessagetaskid() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装消息 UnVarnishedMessage message = new UnVarnishedMessage.Builder().appId(appId).title("java sdk 推送标题 ").content("java sdk 推送内容 ").build(); ResultPack<Long> result = push.gettaskid(pushtype.direct, message); System.out.println(result); pushid 消息推送 (pushmessagebytaskid) ResultPack<PushResult> pushmessagebytaskid(pushtype pushtype, long appid, long taskid, List<String> pushids) ResultPack<PushResult> pushmessagebytaskid(pushtype pushtype, long appid, long taskid, List<String> pushids, int retries) 任务消 息推送 任务消 息推送 参数 pushtype PushType 是 null 消息 appid Long 是 null 推送应用 ID 18/39

19 taskid Long 是 null 推送任务 ID pushids List 是 null 推送目标, 一批最多不能超过 1000 个 retries int 否 0 超时 or 异常重试次数 PushResult msgid; 推送消息 ID, 用于推送流程明细排查 resptarget; 推送目标结果状态 (key: 推送响应码 value: 响应码对应的目标用户 ) 注 : 只返回不合法 超速以及推送失败的目标用户, 业务一般对超速的 pushid 对处理 /** * 任务消息推送 (pushmessagebytaskid) IOException */ public void testpushpytaskid() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 目标用户 List<String> pushids = new ArrayList<String>(); pushids.add("pushid_1"); pushids.add("pushid_2"); // 通知栏任务消息推送 Long taskid = 123l; // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessagebytaskid(pushtype.statusbar, appid, taskid, pushids, 0); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if 19/39

20 (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); // 透传消息任务推送 taskid = 123l; // 1 调用推送服务 result = push.pushmessagebytaskid(pushtype.direct, appid, taskid, pushids, 0); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co 20/39

21 de())) { //TODO 5 业务处理, 重推... System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); 别名消息推送 (pushaliasmessagebytaskid) ResultPack<PushResult> pushaliasmessagebytaskid(pushtype pushtype, long appid, long taskid, List<String> alias) ResultPack<PushResult> pushaliasmessagebytaskid(pushtype pushtype, long appid, long taskid, List<String> alias, int retries) 任务消 息推送 任务消 息推送 参数 pushtype PushType 是 null 消息 appid Long 是 null 推送应用 ID taskid Long 是 null 推送任务 ID alias List 是 null 推送目标别名, 一批最多不能超过 1000 个 retries int 否 0 超时 or 异常重试次数 PushResult msgid; 推送消息 ID, 用于推送流程明细排查 resptarget; 推送目标结果状态 (key: 推送响应码 value: 响应码对应的目标用户 ) 注 : 只返回不合法 超速以及推送失败的目标用户, 业务一般对超速的 pushid 对处理 ** * 别名任务消息推送 * IOException 21/39

22 */ public void testpushaliaspytaskid() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 目标用户 List<String> alias = new ArrayList<String>(); alias.add("alias123"); alias.add("android654"); // 通知栏任务消息推送 Long taskid = 45361L; // 1 调用推送服务 ResultPack<PushResult> result = push.pushaliasmessagebytaskid(pushtype.statusbar, appid, taskid, alias); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co de())) { //TODO 5 业务处理, 重推... System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); 22/39

23 // 透传消息任务推送 taskid = 45407L; // 1 调用推送服务 result = push.pushaliasmessagebytaskid(pushtype.direct, appid, taskid, alias); if (result.issucceed()) { // 2 调用推送服务成功 ( 其中 map 为设备的具体推送结果, 一般业务针对超速的 code 做处理 ) PushResult pushresult = result.value(); String msgid = pushresult.getmsgid();// 推送消息 ID, 用于推送流程明细排查 Map<Integer, List<String>> targetresultmap = pushresult.getresptarget();// 推送结果, 全部推送成功, 则 map 为 empty System.out.println("push msgid:" + msgid); System.out.println("push targetresultmap:" + targetresultmap); if (targetresultmap!= null &&!targetresultmap.isempty()) { // 3 判断是否有获取超速的 target if (targetresultmap.containskey(pushresponsecode.rsp_speed_limit.getvalue())) { // 4 获取超速的 target List<String> ratelimittarget = targetresultmap.get(pushresponsecode.rsp_speed_limit.getvalue()); System.out.println("rateLimitTarget is :" + ratelimittarget); //TODO 5 业务处理, 重推... else { // 调用推送服务异常 eg: appid appkey 非法 推送消息非法... // result.code(); // 服务异常码 // result.comment();// 服务异常 // 全部超速 if (String.valueOf(ErrorCode.APP_REQUEST_EXCEED_LIMIT.getValue()).equals(result.co de())) { //TODO 5 业务处理, 重推... System.out.println(String.format("pushMessage error code:%s comment:%s", result.code(), result.comment())); 应用全部推送 (pushtoapp) 23/39

24 ResultPack<Long> pushtoapp(pushtype pushtype, Message message) 应用全部推送 参数 pushtype PushType 是 null 消息 message Message 是 null 消息体 Long 任务 ID /** * 应用全部推送 (pushtoapp) IOException */ public void testpushtoapp() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 通知栏全部消息推送 VarnishedMessage message = new VarnishedMessage.Builder().appId(appId).title("java Sdk 全部推送标题 ").content("java Sdk 全部推送内容 ").noticeexpandtype(1).noticeexpandcontent(" 展开文本内容 ").clicktype(2).url(" {\"k1\":\"value1\",\"k2\":0,\"k3\":\"value3\"")).offline(true).validtime(12).suspend(true).clearnoticebar(true).vibrate(false).lights(false).sound(false).fixspeed(true).fixspeedrate(30).pushtimetype(1).starttime(new Date()).build(); ResultPack<Long> result = push.pushtoapp(pushtype.statusbar, message); System.out.println(result); // 透传全部推送 UnVarnishedMessage message2 = new UnVarnishedMessage.Builder().appId(appId).title("Java SDK 全部推送标题 ").content("java Sdk 全部推送内容 ").isoffline(true) 24/39

25 .validtime(10).pushtimetype(1).starttime(new Date()).build(); result = push.pushtoapp(pushtype.direct, message2); System.out.println(result); 应用标签推送 (pushtotag) ResultPack<Long> pushtotag(pushtype pushtype, Message message, List<String> tagname, ScopeType scopetype) 应用标 签推送 参数 pushtype PushType 是 null 消息 message Message 是 null 消息体 tagname List 是 null 推送标签 scopetype ScopeType 是 null 标签集合 Long 任务 ID /** * 标签推送 (pushtotag) * IOException */ public void testpushtotag() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 推送标签 List<String> tagname = new ArrayList<String>(); tagname.add("news"); 25/39

26 tagname.add("tech"); // 通知栏标签推送 VarnishedMessage varnishedmessage = new VarnishedMessage.Builder().appId(appId).title("java Sdk 标签推送标题 ").content("java Sdk 标签推送内容 ").noticeexpandtype(1).noticeexpandcontent(" 展开文本内容 ").offline(true).validtime(12).suspend(true).clearnoticebar(true).vibrate(false).lights(false).sound(false).fixspeed(true).fixspeedrate(30).pushtimetype(1).starttime(new Date()).build(); ResultPack<Long> result = push.pushtotag(pushtype.statusbar, varnishedmessage, tagname, ScopeType.INTERSECTION); System.out.println(result); // 透传标签推送 UnVarnishedMessage unvarnishedmessage = new UnVarnishedMessage.Builder().appId(appId).title("Java SDK 标签推送标题 ").content("java Sdk 标签推送内容 ").isoffline(true).validtime(10).pushtimetype(1).starttime(new Date()).build(); result = push.pushtotag(pushtype.direct, unvarnishedmessage, tagname, ScopeType.UNION); System.out.println(result); 取消推送任务 (canceltaskpush) ResultPack<Boolean> canceltaskpush(pushtype pushtype, long appid, long taskid) 只针对全部用户推送以及标签推送且推送状 态为待推送或者推送中的任务取消 参数 pushtype PushType 是 null 消息 appid Long 是 null 应用 ID 26/39

27 taskid Long 是 null 任务 ID Boolean true: 成功 false: 失败 /** * 取消推送任务 (canceltaskpush) 只针对全网推送生效 IOException */ public void testcanceltaskpush() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); long taskid = 123l; ResultPack resultpack = push.canceltaskpush(pushtype.statusbar, appid, taskid); System.out.println(resultPack); 推送统计 获取任务推送统计 (gettaskstatistics) public ResultPack<TaskStatistics> gettaskstatistics(long appid, long taskid) 获取推送统 计 参数 appid Long 是 null 应用 ID taskid Long 是 null 任务 ID TaskStatistics 27/39

28 /** * 获取任务统计结果 * IOException */ public void testgettaskstatistics() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); long taskid = 44760L; ResultPack<TaskStatistics> resultpack = push.gettaskstatistics(appid, taskid); System.out.println(resultPack); 获取应用推送统计 (dailypushstatics) public ResultPack<List<DailyPushStatics>> dailypushstatics(long appid, Date starttime, Date endtime) 获取应用推 送统计 参数 appid Long 是 null 应用 ID starttime Date 是 null 开始日期 endtime Date 是 null 结束日期 List<DailyPushStatics> /** * 获取任务统计结果 * IOException 28/39

29 */ public void testdailypushstatics() throws IOException { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); Date starttime = DateUtils.str2Date(" ", "yyyy-mm-dd"); Date endtime = DateUtils.str2Date(" ", "yyyy-mm-dd"); ResultPack<List<DailyPushStatics>> resultpack = push.dailypushstatics(appid, starttime, endtime); System.out.println(resultPack); 高级功能 消息送达与回执支持回执 pushid 通知栏消息推送 (pushmessage) 别名通知栏消息推送 (pushmessagebyalias) 开发者通过设置通知栏消息 extra 来指定消息的送达和点击回执规则回执地址请登录推送平台 配置管理 -> 回执管理 注册回执地址 key value 含义 callback 回执 ( 第三方接收回执的 Http, 最大长度 128 字节 ) callback.param 回执参数 ( 第三方自定义回执参数, 最大长度 64 字节 ) callback.type 回执 ((1- 送达回执, 2- 点击回执, 3- 送达与点击回执 ), 3) 魅族推送服务器每隔 1s 将已送达或已点击的消息 ID 和对应设备的 pushid 或 alias 通过调用开发者 http 传给开发者 ( 每次调用后, 魅族推送服务器会清空这些数据, 下次传给业务方将是新一拨数据 ) 注 : 消息的送达回执只支持向 pushid 或 alias 发送的消息 单个应用注册不同回执地址累计上限不能超过 100 个 回执响应内容 key value cb 回执明细内容如下所述 (Json 数据 ) 29/39

30 access_token 回执访问令牌 ( 推送平台设置回执地址令牌 ) 回执明细格式 : 外层 key 代表相应的消息 id 和回执 (msgid-type), value 是一个 JSONObject, 包含了下面的参数值 param: 业务上传的自定义参数值 type: callback targets: 一批 alias 或者 pushid 集合 { "msgid2-1": { "param": "param2", "type": 1, "targets": [ "pushid3", "pushid2", "pushid1" ], "msgid1-2": { "param": "param1", "type": 2, "targets": [ "alias2", "alias", "alias1" ] 抓包 Hypertext Transfer Protocol POST /callbackurl/callback HTTP/1.1\r\n [Expert Info (Chat/Sequence): POST /callbackurl/callback HTTP/1.1\r\n] Request Method: POST Request URI: /callbackurl/callback Request Version: HTTP/1.1 Content-Length: 32\r\n [Content length: 32] Content-Type: application/x-www-form-urlencoded; charset=utf-8\r\n Host: xxx.xxx.xxx\r\n Connection: Keep-Alive\r\n 30/39

31 User-Agent: Apache-HttpClient/4.3.4 (java 1.5)\r\n Accept-Encoding: gzip,deflate\r\n \r\n [Full request URI: [HTTP request 1/1] [Response in frame: 7253] File Data: 32 bytes HTML Form URL Encoded: application/x-www-form-urlencoded Form item: "access_token" = "token" Key: access_token Value: token Form item: "cb" = "json value" Key: cb Value: json value public void testpushidcallback() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装消息 VarnishedMessage message = new VarnishedMessage.Builder().appId(appId).title("Java SDK 推送标题 ").content("java SDK 推送内容 ").extra(extraparam.callback.getkey(), callbackurl).extra(extraparam.callback_param.getkey(), "param").extra(extraparam.callback_type.getkey(), CallBackType.RECEIVE.getKey()).build(); // 目标用户 List<String> pushids = new ArrayList<String>(); pushids.add("pushid_1"); pushids.add("pushid_2"); // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessage(message, pushids); handleresult(result); public void testaliascallback() throws Exception { // 推送对象 IFlymePush push = new IFlymePush(APP_SECRET_KEY); // 组装消息 VarnishedMessage message = new VarnishedMessage.Builder().appId(appId).title("Java SDK 推送标题 ").content("java SDK 推送内容 ") 31/39

32 .extra(extraparam.callback.getkey(), callbackurl).extra(extraparam.callback_param.getkey(), "param").extra(extraparam.callback_type.getkey(), CallBackType.RECEIVE.getKey()).build(); alias); // 目标用户 List<String> alias = new ArrayList<String>(); alias.add("alias_1"); alias.add("alias_2"); // 1 调用推送服务 ResultPack<PushResult> result = push.pushmessagebyalias(message, handleresult(result); 订阅服务 修改通知栏订阅开关状态 (updatestatusbarswitch) ResultPack<SwitchStatusInfo> updatestatusbarswitch(string pushid, Boolean subswitch) 修改通知栏订阅开 关状态 参数 pushid String 是 null 订阅 pushid subswitch Boolean 是 null 开关状态 true: 打开 false: 关闭 SwitchStatusInfo public void updatestatusbarswitch() throws Exception { ResultPack<SwitchStatusInfo> resultpack = sub.updatestatusbarswitch(pushid, true); System.out.println("updateStatusbarSwitch:" + resultpack); 32/39

33 修改透传订阅开关状态 (updatedirectswitch) ResultPack<SwitchStatusInfo> updatedirectswitch(string pushid, Boolean subswitch) 修改透传订阅开关 状态 参数 pushid String 是 null 订阅 pushid subswitch Boolean 是 null 开关状态 true: 打开 false: 关闭 SwitchStatusInfo public void updatedirectswitch() throws Exception { ResultPack<SwitchStatusInfo> resultpack = sub.updatedirectswitch(pushid, false); System.out.println("updateDirectSwitch:" + resultpack); 同步修改所有开关状态 (updateallswitch) ResultPack<SwitchStatusInfo> updateallswitch(string pushid, Boolean subswitch) 同步修改所有开关 状态 参数 pushid String 是 null 订阅 pushid 33/39

34 subswitch Boolean 是 null 开关状态 true: 打开 false: 关闭 SwitchStatusInfo public void updateallswitch() throws Exception { ResultPack<SwitchStatusInfo> resultpack = sub.updateallswitch(pushid, true); System.out.println("updateAllSwitch:" + resultpack); 获取订阅开关状态 (updateallswitch) ResultPack<SwitchStatusInfo> getregisterswitch(string pushid) 获取订阅开关状态 参数 pushid String 是 null 订阅 pushid SwitchStatusInfo public void getregisterswitch() throws Exception { ResultPack<SwitchStatusInfo> resultpack = sub.getregisterswitch(pushid); System.out.println("getRegisterSwitch:" + resultpack); 34/39

35 别名订阅 (subscribealias) ResultPack<AliasInfo> subscribealias(string pushid, String alias) 别名订阅 参数 pushid String 是 null 订阅 pushid alias String 是 null 订阅别名 60 字符限制 AliasInfo public void subscribealias() throws Exception { ResultPack<AliasInfo> resultpack = sub.subscribealias(pushid, "flyme"); System.out.println("subscribeAlias:" + resultpack); 取消别名订阅 (unsubscribealias) ResultPack<AliasInfo> unsubscribealias(string pushid) 取消别名订阅 参数 pushid String 是 null 订阅 pushid AliasInfo 35/39

36 public void unsubscribealias() throws Exception { ResultPack<AliasInfo> resultpack = sub.unsubscribealias(pushid); System.out.println("unSubscribeAlias:" + resultpack); 获取订阅别名 (getsubalias) ResultPack<AliasInfo> getsubalias(string pushid) 获取订阅别名 参数 pushid String 是 null 订阅 pushid AliasInfo public void getsubalias() throws Exception { ResultPack<AliasInfo> resultpack = sub.getsubalias(pushid); System.out.println("getSubAlias:" + resultpack); 标签订阅 (subscribetags) ResultPack<TagInfo> subscribetags(string pushid, List<String> tags) 标签订阅 参数 36/39

37 pushid String 是 null 订阅 pushid tags List 是 null 订阅标签 ( 单个标签 20 个字符限制,100 个标签数量限制 ) TagInfo public void subscribetags() throws Exception { List<String> tags = new ArrayList<String>(2); tags.add("tag1"); tags.add("tag2"); ResultPack<TagInfo> resultpack = sub.subscribetags(pushid, tags); System.out.println("subscribeTags:" + resultpack); 取消标签订阅 (unsubscribetags) ResultPack<TagInfo> unsubscribetags(string pushid, List<String> tags) 取消标签订阅 参数 pushid String 是 null 订阅 pushid tags List 是 null 订阅标签 ( 单个标签 20 个字符限制,100 个标签数量限制 ) TagInfo public void unsubscribetags() throws Exception { 37/39

38 List<String> tags = new ArrayList<String>(2); tags.add("tag1"); tags.add("tag2"); ResultPack<TagInfo> resultpack = sub.unsubscribetags(pushid, tags); System.out.println("unSubscribeTags:" + resultpack); 获取订阅标签 (getsubtags) ResultPack<TagInfo> getsubtags(string pushid) 获取订阅标签 参数 pushid String 是 null 订阅 pushid TagInfo public void getsubtags() throws Exception { ResultPack<TagInfo> resultpack = sub.getsubtags(pushid); System.out.println("getSubTags:" + resultpack); 取消订阅所有标签 (unsuballtags) ResultPack<Boolean> unsuballtags(string pushid) 取消订阅所有标签 参数 pushid String 是 null 订阅 pushid 38/39

39 Boolean public void unsuballtags() throws Exception { ResultPack<Boolean> resultpack = sub.unsuballtags(pushid); System.out.println("unSubAllTags:" + resultpack); 39/39