Microsoft Word - 个推平台服务端MMP接口文档-v1.010.docx

Size: px

Start display at page:

Download "Microsoft Word - 个推平台服务端MMP接口文档-v1.010.docx"

楣璎尤
4 years ago
Views:

1 个推平台服务端 MMP 接口文档 v 日期 : 2017 年 9 月 18 日

2 变更记录序号变更时间变更人变更内容文档版本 MMP-SDK 版本年 1 月 11 日赵志强岳柳含年 8 月 16 日李居启年 9 月 18 日陈锋 1 补充报表查询接口说明 2 更换对外文档模板 1 透传模板, 增加第三方通知发送, 补充 IOS 消息说明 1 底层实现还原到版本 ( 使用 netty3 版本 ) 2 在基础上增加查询接口及透传带通知功能 3 该版本不支持代理功能 v v v

3 目录 1. 开发准备获取 AppID 参数等搭建开发环境接口类型推送接口具体参数查询接口具体参数效果 pushmessagetosingle 接口代码开发返回结果示例返回结果说明 pushmessagetolist 接口代码开发返回结果示例返回结果说明报表查询接口 getpushresult 接口 getpushresultbytaskidlist 接口 getpushresultbygroupname 接口 queryapppushdatabydate 接口 queryappuserdatabydate 接口数据字段说明参数说明通知模板通知模板类附 : pushmessagetolist 四种推送消息模板例程 TransmissionTemplate( 透传消息模板 ) NotificationTemplate( 点击通知启动应用 ) LinkTemplate( 点击通知打开网页 ) PopupTransmissionTemplate( 弹框通知启动应用 )... 28

4 附 :Andriod 开发工程师生成 intent 参考... 29

5 1. 开发准备 1) 请确保您已经初始化 SDK 成功并得到 ClientID 2) ( 参见个推平台客户端 SDK 接入文档扩展功能获取透传消息 ( 可选 ) 章节, 文件位于 : 个推 Android 平台 SDK 接入客户端文档目录下 ) 3) MMP 优势 : l 采用 Socket 长连接, 推送更快, 单推性能是 OpenService 的两倍, 群推性能是 OpenService 的五倍 l 除支持通过下行接口向手机客户端推送消息外, 支持上行接口从手机客户端给第三方的发送消息 4) 术语 : l 上行 : 手机客户端给第三方服务器发送消息 l 下行 : 第三方服务器给手机客户端发送消息 1.1 获取 AppID 参数等 1) AppID: 例 :b03c5cfef65ed30108f0a3fd82c3f6b4, 您应用的唯一标识符 2) AppKey: 例 : ) MasterSecret: 例 :a02a76119b20d4e31620d7597a3b4f35 双方各自开一个固定密钥供对方访问服务器时用,AppKey MasterSecret 代表第三方使用的标识和对应密钥, 用于对您应用的鉴权

6 注 : 在个推开放平台 ( 首页登记应用后, 可以在配置管理应用配置看到如上参数, 如下图所示 : 1.2 搭建开发环境 1) 在 Eclipse 中新建一个工程 ( 注 : 工程类型为 Java Project) 2) 在工程中新建一个 libs 目录, 将个推 Android 平台 SDK 接入 / 服务端 / 需导入资源服务端目录下的所有 jar 包复制到该目录中 ( 若没有 libs 目录, 则选中工程右键 New ->Folder-> 命名为 libs ) 3) 右键单击工程, 选择 Build Path 中的 Configure Build Path..., 选中 Libraries 这个 tab, 并通过 Add Jars... 导入工程 libs 目录下的所有 jar 文件, 共 7 个

2. 接口类型 2.1 推送接口 2.1.1 具体参数接口名称支持推送类型说明 pushmessagetosingle 透传 (payload) 点击通知启动应用对单个用户推送点击通知打开网页等 pushmessagetolist 2.2 查询接口 2.2.1 具体参数透传 (payload) 点击通知启动应用点击通知打开网页等 ( 通过 ClientID 列表 ) 群推接口名称

7 2. 接口类型 2.1 推送接口具体参数接口名称支持推送类型说明 pushmessagetosingle 透传 (payload) 点击通知启动应用对单个用户推送点击通知打开网页等 pushmessagetolist 2.2 查询接口具体参数透传 (payload) 点击通知启动应用点击通知打开网页等 ( 通过 ClientID 列表 ) 群推接口名称 getpushresult getpushresultbytaskidlist getpushresultbygroupname queryapppushdatabydate queryappuserdatabydate 说明根据单个 taskid 查询任务报表接口根据 taskid 列表批量查询任务报表接口查询任务组名的推送报表查询应用维度的推送数据查询应用维度的用户数据效果 < 点击通知启动应用 > 推送效果如下 :

1) 用户点击如上图推送的消息后 SDK 将 payload 消息传给您的客户端 2) 您客户端接收 payload 消息后 ( 需要写代码 ) 决定以何种形式处理展现给用户 < 点击通知打开网页 > 推送效果如下 : 1) 在手机通知栏显示推送的消息 ( 如图 2.2 左 ) 2) 用户点击消息将启动浏览器跳转到您设定的网页 ( 如图 2.2 右 ) 2.

8 1) 用户点击如上图推送的消息后 SDK 将 payload 消息传给您的客户端 2) 您客户端接收 payload 消息后 ( 需要写代码 ) 决定以何种形式处理展现给用户 < 点击通知打开网页 > 推送效果如下 : 1) 在手机通知栏显示推送的消息 ( 如图 2.2 左 ) 2) 用户点击消息将启动浏览器跳转到您设定的网页 ( 如图 2.2 右 ) 2.3 pushmessagetosingle 接口代码开发 1) 新建主类 ( 包含 main 函数 ), 比如命名为 PushMessageToSingleTest 2) 在主类中定义需传递的数据, 并调用远程接口 ( 示例代码如下 ) 3) 请确保您已经初始化 SDK 成功, 如果推送的是 TransmissionTemplate 类型, 需要客户端做相应开发 ( 参见个推平台客户端 SDK 接入文档扩展功能获取透传消息 ( 可选 ) 章节 ) package com.igetui.api.mmp; import java.util.arraylist; import java.util.list; import java.util.map; import com.gexin.rp.sdk.base.iigtpush; import com.gexin.rp.sdk.base.ipushresult;

9 import com.gexin.rp.sdk.base.impl.singlemessage; import com.gexin.rp.sdk.base.impl.target; import com.gexin.rp.sdk.tcp.receptionhandler; import com.gexin.rp.sdk.tcp.client.gtpush; import com.gexin.rp.sdk.template.*; public class PushMessageToSingleTest { private static final APPID = " 您应用的 AppID"; private static final APPKEY = " 您应用的 AppKey"; private static final MASTERSECRET = " 您应用的 MasterSecret"; private static final CLIENTID = " 您客户端的 ClientID"; private static final API = " "; //MMP 接口地址 public static void main([] args) { // 和 MMP 服务端建立连接,ReceptionHandler( 用来处理第三方的上行消息, // 如果不需要处理上行消息, 可以传入 null) IIGtPush push = GtPush.getInstance(API, 5266, APPKEY, MASTERSECRET, new ReceptionHandler() { ); // 第三方用来处理上行消息 ( 手机客户端发给第三方服务器的消息 ) public void receive(iigtpush push, Map<, Object> message) { // 处理逻辑 System.out.println(message); try { // 1. 连接 : 实现 SDK 和服务端, 连接成功后才可以推送 boolean flag = push.connect(); if (!flag) { return;

10 // 2. 单推消息类型 SingleMessage message = new SingleMessage(); // 3. 推送消息模版. 这里共有 TransmissionTemplate( 透传消息模板 ) NotificationTemplate( 点击通知启动应用 ) LinkTemplate( 点击通知打开网页 ) 三种 // 这里以 NotificationTemplate 为例 NotificationTemplate template = new NotificationTemplate(); template.setappid(appid); // 应用 APPID template.setappkey(appkey); // 应用 APPKEY // 通知属性设置 : 如通知的标题, 内容 template.settitle(" 填写通知标题 "); // 通知标题 template.settext(" 填写通知内容 "); // 通知内容 template.setlogo("push.png"); // 通知图标 // template.setisring(true); // 收到通知是否响铃, 可选, 默认响铃 // template.setisvibrate(true); // 收到通知是否震动, 可选, 默认振动 // template.setisclearable(true); // 通知是否可清除, 可选, 默认可清除 template.settransmissiontype(2); // 收到消息是否立即启动应用,1 为立即启动,2 则广播等待客户端自启动 template.settransmissioncontent(" 你需要透传的内容 "); // 透传内容 ( 点击通知后 SDK 将透传内容传给你的客户端, 需要客户端做相应开发 ) message.setdata(template); // message.setoffline(true); // 用户当前不在线时, 是否离线存储, 可选, 默认不存储 // message.setofflineexpiretime(72 * 3600); // 离线有效时间, 单位为秒, 可选 message.setpriority(1); // 设置优先级, 分别对应优先级 : 高中低 // 4. 推送对象 List<Target> targets = new ArrayList<Target>(); Target target = new Target(); target.setappid(appid); // 接收者安装的应用的 APPID // 单推 IPushResult ret; try { target.setclientid(clientid); // 接收者的 ClientID targets.add(target);

11 推送 ) // 5. 推送, 返回推送结果 ( 连接成功后, 这里可以多次推送, 也可以多线程调用 ret = push.pushmessagetosingle(message, target); System.out.println(ret.getResponse().to()); catch (Exception e) { e.printstacktrace(); 如上以 pushmessagetosingle 接口为例, 介绍了如何调用远程接口 pushmessagetosingle 接口支持推送如下三种类型的通知 / 消息 :TransmissionTemplate NotificationTemplate NotificationTemplate 通知类型设置参见 : 通知模板类返回结果示例返回结果说明 // 6. 所有推送任务结束后, 关闭 SDK 和服务端连接 push.close(); catch (Exception e) { {taskid=mmps-0410-f b e-58cc1f71876b, result=successed_ignore,msgid=mmps-0410-f b e-58cc1f71876b, info=not login within 3 months, ignore this message 名称返回值说明 taskid 任务编号操作成功是返回任务编号 result successed_online 操作成功 ( 在线下发 ) successed_offline 操作成功 ( 离线下发 ) successed_ignore 操作成功 ( 超过 3 个月, 忽略掉 ) failed 操作失败, 通过 Info 可以查看出错原因 msgid 消息编号每条消息的唯一编号 info 错误描述出错时, 描述出错原因

12 2.4 pushmessagetolist 接口代码开发 1) 按照开发准备搭建开发环境章节步骤 [1]-[3], 新建工程 (Java Project), 并导入 jar 包如下图所示, 新建名为 PushMessageToList 的工程 2) 新建主类 ( 包含 main 函数 ), 比如命名为 PushMessageToListTest 3) 在主类中定义需传递的数据, 并调用远程接口 ( 示例代码如下, 所有模板类的示例代码见附件 ) package com.igetui.api.mmp; import java.util.arraylist; import java.util.list; import java.util.map; import com.gexin.rp.sdk.base.iigtpush; import com.gexin.rp.sdk.base.ipushresult; import com.gexin.rp.sdk.base.impl.listmessage; import com.gexin.rp.sdk.base.impl.target; import com.gexin.rp.sdk.tcp.receptionhandler; import com.gexin.rp.sdk.tcp.client.gtpush; import com.gexin.rp.sdk.template.*; public class PushMessageToListTest { private static final APPID = " 您应用的 AppID"; private static final APPKEY = " 您应用的 AppKey"; private static final MASTERSECRET = " 您应用的 MasterSecret"; private static final CLIENTID = " 您客户端的 ClientID"; private static final API = " "; //MMP 接口地址 public static void main([] args) { // MMP 服务 IP 或域名端口第三方 appkey mastsecret ReceptionHandler( 用来处理第三方的业务逻辑 ) IIGtPush push = GtPush.getInstance(API, 5266, APPKEY, MASTERSECRET, new ReceptionHandler() {

13 ); // 这里第三方用来处理业务逻辑 public void receive(iigtpush push, Map<, Object> message) { System.out.println(message); try { // 1. 连接连接成功后才可以推送 boolean flag = push.connect(); if (!flag) { return; try { // 2. 群推消息类型 ListMessage message = new ListMessage(); // 3. 推送消息模版. 这里共有 TransmissionTemplate( 透传消息模板 ) NotificationTemplate( 点击通知启动应用 ) LinkTemplate( 点击通知打开网页 ) PopupTransmissionTemplate( 弹框通知启动应用 ) 四种 // 这里以 LinkTemplate 为例 LinkTemplate template = new LinkTemplate(); template.setappid(appid); // 应用 APPID template.setappkey(appkey); // 应用 APPKEY // 通知属性设置 : 如通知的标题, 内容 template.settitle(" 填写通知标题 "); // 通知标题 template.settext(" 填写通知内容 "); // 通知内容 template.setlogo("hello.png"); // template.setisring(true); // 收到通知是否响铃, 可选, 默认响铃 // template.setisvibrate(true); // 收到通知是否震动, 可选, 默认振动 // template.setisclearable(true); // 通知是否可清除, 可选, 默认可清除 template.seturl(" // 点击通知后打开的网页地址 message.setdata(template);

14 // message.setoffline(true); // 用户当前不在线时, 是否离线存储, 可选, 默认不存储 // message.setofflineexpiretime(72*3600); // 离线有效时间, 单位为秒, 可选 message.setpriority(1); // 设置优先级, 分别对应优先级 : 高中低 // 4. 推送对象 List<Target> targets = new ArrayList<Target>(); Target target1 = new Target(); // Target target2 = new Target(); // 如果需要可设置多个接收者 target1.setappid(appid); // 接收者安装的应用的 APPID target1.setclientid(clientid); // 接收者的 ClientID // 如需, 可设置多个接收者 // target2.setappid(appid2); // 接收者 2 安装应用的 APPID // target2.setclientid(clientid2); // 接收者 2 的 ClientID targets.add(target1); // targets.add(target2); // 5. 批量推送前需要通过这个接口向服务其申请一个 taskid taskid = push.getcontentid(message); // 6. 推送, 返回推送结果 ( 获得 taskid 后, 这里可以多次推送, 也可以多线程调用推送 ) IPushResult ret = push.pushmessagetolist(taskid, targets); System.out.println(ret.getResponse().to()); // 7. 批量推送结束后, 注销该 taskid push.cancelcontentid(taskid); push.close(); catch (Exception e) { e.printstacktrace(); catch(exception e){

15 如上以 pushmessagetolist 接口为例, 介绍了如何调用远程接口 pushmessagetolist 接口支持推送如下三种类型的通知 / 消息 :TransmissionTemplate NotificationTemplate NotificationTemplate 通知类型设置参见 : 通知模板类 4) 请确保您已经初始化 SDK 成功, 如果推送的是 TransmissionTemplate 类型, 需要客户端做相应开发 ( 参见个推平台客户端 SDK 接入文档扩展功能获取透传消息 ( 可选 ) 章节 ) 5) void pushmessagetolist(listmessage message, IListProvider listprovider, IPushEventListener listener); 第三方向一批用户群推消息, 通过 IListProvider 接口提供推送列表, 实现分页, 推送结果通过回调 IPushEventListener 接口传入附 : 1)IListProvider 接口, 第三方实现 getclientlist() 方法分页 com.gexin.rp.sdk.base.ilistprovider public interface IListProvider { List<Target> getclientlist(int page); 2)IPushEventListener 接口, 第三方实现 process() 处理推送结果 com.gexin.rp.sdk.base.ipusheventlistener public interface IPushEventListener { public void process(ipushresult pushresult); 返回结果示例 {taskid=mmpl c6fc95c f-aca b9cd543, results=[{taskid=mmpl c6fc95c f-aca b9cd543, result=successed_ignore, msgid=mmpl f822fe a-8bed-4e0c1b8d70b4, info=not login within 3 months, ignore this message, {taskid=mmpl c6fc95c f-aca b9cd543, result=successed_ignore, msgid=mmpl ebcbd1-76b2-47a8-a ec6f10efd, info=not login within 3 months, ignore this message] pushmessagetolist 接口返回值包含对每个用户的推送结果, 相当于 pushmessagetosingle 推送结果的一个集合

16 2.4.3 返回结果说明名称返回值说明 taskid 任务编号操作成功是返回任务编号 results result result 的结构见 pushmessagetosingle 返回结果 2.5 报表查询接口 getpushresult 接口 1) 说明根据单个 taskid 查询任务报表, 包括下发回执等信息 2) 代码示例 package Mmp; import com.gexin.rp.sdk.base.ipushresult; import com.gexin.rp.sdk.tcp.client.gtpush; public class getpushresult { public static void main([] args) throws Exception { mmpip = "sdk.open.mmp.igexin.com"; appkey = ""; mastersecret = ""; OSURL = " "; GtPush push = GtPush.getInstance(mmpip, 5266, appkey, mastersecret, null, OSURL); taskid = ""; IPushResult ret =push.getpushresult(taskid); System.out.println(ret.getResponse()); 3) 返回结果示例 {taskid=mmpl-0109-e1bbe1ef-5f12-43cd-96ed-eae450788a52, result=ok, GT={"feedback":0,"displayed":0,"result":"ok","sent":0,"clicked":0, pushnum=0, msgtotal=2, clicknum=0, msgprocess=0 具体说明见数据字段说明 - 任务报表字段说明

17 2.5.2 getpushresultbytaskidlist 接口 1) 说明根据传入的 taskid 列表批量查询任务报表 2) 代码示例 package Mmp; import com.gexin.rp.sdk.base.ipushresult; import com.gexin.rp.sdk.tcp.client.gtpush; import java.util.arrays; public class getpushresult { public static void main([] args) throws Exception { mmpip = "sdk.open.mmp.igexin.com"; appkey = ""; mastersecret = ""; OSURL = " "; GtPush push = GtPush.getInstance(mmpip, 5266, appkey, mastersecret, null, OSURL); taskid1 = ""; taskid2 = ""; IPushResult ret =push.getpushresultbytaskidlist (Arrays.asList(taskId1, taskid2)); System.out.println(ret.getResponse()); 3) 返回结果示例 {result=ok, resultlist=[{"taskid":"mmpl ec a40-ab ed88b","result":"ok"," GT":"{\"feedback\":0,\"displayed\":0,\"result\":\"ok\",\"sent\":0,\"clicked\":0","pushNum":0," msgtotal":2,"clicknum":0,"msgprocess":0,{"taskid":"mmpl-0109-e1bbe1ef-5f12-43cd-96ed -eae450788a52","result":"ok","gt":"{\"feedback\":0,\"displayed\":0,\"result\":\"ok\",\"sent\":0,\ "clicked\":0","pushnum":0,"msgtotal":2,"clicknum":0,"msgprocess":0] 具体说明见数据字段说明 - 任务报表字段说明

18 2.5.3 getpushresultbygroupname 接口 1) 说明根据任务组名查询任务组下发汇总数据 2) 代码示例 package Mmp; import com.gexin.rp.sdk.base.iqueryresult; import com.gexin.rp.sdk.tcp.client.gtpush; public class getpushresult { public static void main([] args) throws Exception { mmpip = "sdk.open.mmp.igexin.com"; appid = ""; appkey = ""; mastersecret = ""; OSURL = " "; GtPush push = GtPush.getInstance(mmpip, 5266, appkey, mastersecret, null, OSURL); taskgroupname = ""; IQueryResult ret =push.getpushresultbygroupname(appid, taskgroupname); System.out.println(ret.getResponse()); 3) 返回结果示例 {result=ok, GT={"feedback":0,"displayed":0,"result":"ok","sent":0,"clicked":0, groupname=task_group_name, shownum=0, msgtotal=4, onlinenum=0, clicknum=0, msgprocess=0 具体说明见数据字段说明 - 任务报表字段说明

19 2.5.4 queryapppushdatabydate 接口 1) 说明根据日志查询应用维度的推送数据 2) 代码示例 package Mmp; import com.gexin.rp.sdk.base.iqueryresult; import com.gexin.rp.sdk.tcp.client.gtpush; public class getpushresult { public static void main([] args) throws Exception { mmpip = "sdk.open.mmp.igexin.com"; appid = ""; appkey = ""; mastersecret = ""; date = " "; OSURL = " "; GtPush push = GtPush.getInstance(mmpip, 5266, appkey, mastersecret, null, OSURL); IQueryResult ret = push.queryapppushdatabydate(appid, date); System.out.println(ret.getResponse()); 3) 返回结果示例 {result=ok,gt={"sent":88,"feedback":77,"displayed":66,"clicked":55,apn={"sent":88,"feedbac k":-1,"displayed":66,"clicked":55,data={"appid":"46llrxgwiq6bj4qhxton9","clickcount":0,"r eceivecount":4,"sendcount":0,"showcount":0,"sendonlinecount":0,"date":" " 具体说明见数据字段说明 - 应用维度推送数据字段说明

20 2.5.5 queryappuserdatabydate 接口 1) 说明根据日志查询应用维度的推送数据 2) 代码示例 package Mmp; import com.gexin.rp.sdk.base.iqueryresult; import com.gexin.rp.sdk.tcp.client.gtpush; public class getpushresult { public static void main([] args) throws Exception { mmpip = "sdk.open.mmp.igexin.com"; appid = ""; appkey = ""; mastersecret = ""; date = " "; OSURL = " "; GtPush push = GtPush.getInstance(mmpip, 5266, appkey, mastersecret, null, OSURL); IQueryResult ret = push.queryappuserdatabydate(appid, date); System.out.println(ret.getResponse()); 3) 返回结果示例 {result=success, data={"appid":"46llrxgwiq6bj4qhxton9","registtotalcount":5,"activecount":0,"onlinecount": 0,"date":" ","newRegistCount":0 具体说明见数据字段说明 - 应用维度推送数据字段说明

21 2.5.6 数据字段说明查询接口通过个推通道下发的任务标识为 GT 返回数据结构为如下通道标识对应 JSON 字符串格式的形式 : "GT":"{feedback:0,displayed:0,result:ok,sent:0,clicked:0" 考虑到向下兼容, 原来通过个推通道的下发数据 msgtotal pushnum msgprocess shownum clicknum 这些字段仍然按原格式返回应用维度的数据查询, 既有安卓推送又有 APN 推送, 推送数据查询会做拆分, 通过个推通道下发的消息标识为 GT, 通过 APNS 下发的消息标识为 APN, 如 : GT={"sent":88,"feedback":77,"displayed":66,"clicked":55,APN={"sent":88,"feedback":-1,"displ ayed":66,"clicked":55 1) 任务报表字段说明字段名说明描述 msgtotal 可下发数推送可下发用户数, 又称百日内联网用户数 pushnum 实际下发数通过个推系统实际下发用户数 msgprocess 到达数实际接收到消息的用户数 shownum 展示数手机客户端接收到消息并且有展示的用户数 clicknum 点击数手机客户端接收到消息后触发点击动作的用户数 sent 实际下发数位于具体下发通道标识下, 如 (GT), 与 pushnum 含义相同, 为具体通道的实际下发数 feedback 到达数位于具体下发通道标识下, 如 (GT) 与 msgprocess 含义相同, 为具体通道的到达数 displayed 展示数位于具体下发通道标识下, 如 (GT), 与 shownum 含义相同, 为具体通道的展示数 clicked 点击数位于具体下发通道标识下, 如 (GT), 与 clicknum 含义相同, 为具体通道的点击数 2) 维度推送数据字段说明字段名说明描述 sendcount 可下发数推送可下发用户数, 又称百日内联网用户数 sendonlinecount 实际下发数通过个推系统实际下发用户数 receivecount 到达数实际接收到消息的用户数

22 showcount 展示数位于具体下发通道标识下, 如 (GT XM HW), 手机客户端接收到消息并且有展示的用户数 clickcount 点击数手机客户端接收到消息后触发点击动作的用户数 3) 应用维度用户数据字段说明字段名说明描述 newregistcount 新增用户数当天应用新注册用户数 registtotalcount 累计注册用户截止到当天, 应用注册用户总数数 activecount 活跃用户数当天应用活跃用户总数 onlinecount 在线用户数当天应用在线用户数 ( 峰值 ) 2.6 参数说明通知模板 pushtype 说明描述 TransmissionTemp 透传数据经 SDK 传给您的客户端, 由您写代码决定如何处 late (payload) 理展现给用户 NotificationTemp 点击通知启动 late 应用 LinkTemplate 点击通知打开网页 PopupTransmissio 弹框通知启动 ntemplate 应用通知模板类 l TransmissionTemplate 在通知栏显示一条含图标标题等的通知, 用户点击后激活您的应用在通知栏显示一条含图标标题等的通知, 用户点击可打开您指定的网页在桌面弹出一含有标题内容的对话框, 用户点击确定按钮激活您的应用成员方法名成员类型成员长度必填说明 setappid 是设定接收的应用 setappkey 是用于鉴定身份是否合法 settransmissioncont ent 2048 中 / 英字符是透传内容, 不支持转义字符

23 settransmissiontype int 4byte 是 setduration 否收到消息是否立即启动应用,1 为立即启动,2 则广等待客户端自启动收到消息的展示时间, 不推荐使用, 消息可能因为此设置被过滤 setapninfo APNPayload 否 ios 推送使用该字段 set3rdnotifyinfo Notify 否第三方通知发送 APNPayload 的说明 : 成员方法名成员类型说明 setautobadge 设置角标, 还可以实现显示数字的自动增减, 如 "+1" "-1" "1" 等 setcontentavailable int 推送直接带有透传数据 setalertmsg AlertMsg 通知消息体 setsound 通知铃声文件名, 无声设置为 "com.gexin.ios.silence" setcategory 在客户端通知栏触发特定的 action 和 button 显示 addcustommsg(,) addmultimedia - 增加自定义的数据,Key-Value 形式 MultiMedia 添加一个多媒体资源, 当前最多传入 3 个资源 setmultimedias List<Multi Media> 设置多媒体资源列表, 单个列表最多支持 3 个资源

24 AlertMsg 子类 APNPayload.SimpleAlertMsg, 直接在构造函数中写入消息内容 AlertMsg 子类 APNPayload.DictionaryAlertMsg 说明 : 成员方法名成员类型说明 setbody 通知文本消息字符串 setactionlockey ( 用于多语言支持 ) 指定执行按钮所使用的 Localizable.strings setlockey ( 用于多语言支持 ) 指定 Localizable.strings 文件中相应的 key addlocarg 如果 loc-key 中使用的占位符, 则在 loc-args 中指定各参数 setlaunchimage 指定启动界面图片名 settitle 通知标题 settitlelockey ( 用于多语言支持 ) 对于标题指定执行按钮所使用的 Localizable.strings, 仅支持 ios8.2 以上版本 addtitlelocarg 对于标题, 如果 loc-key 中使用的占位符, 则在 loc-args 中指定各参数, 仅支持 ios8.2 以上版本 setsubtitle 设置子标题, 仅支持 ios8.2 以上版本 setsubtitlelockey 设置当前本地化文件中的子标题字符串的关键字, 仅支持 ios8.2 以上版本 addsubtitlelocargs 设置当前本地化子标题内容中需要置换的变量参数, 仅支持 ios8.2 以上版本 MultiMedia 的说明 : 成员方法名成员类型说明 setresid 设置资源 id setresurl 设置资源 url setrestype MediaType 设置资源类别 MediaType.pic 图片 MediaType.audio 音频 MediaType.video 视频 setonlywifi boolean 设置是否在 WIFI 下才展示多媒体消息, 如果设置 true 但未使用 WIFI 时会展示成普通通知

25 Notify 的说明 : 成员方法名成员类型成员长度必填说明 settitle 是通知栏标题 setcontent 是通知栏内容 setpayload 否非必填, 可输入透传内容, 类似 2048 中 / APNPayload, 使用此方式的透传消英字符息可能会被华为拦截, 不推荐使用 seturl 否点击通知, 打开应用的链接 setintent 小于否通知带 intent 传递参数推荐使 1000 字用,intent 最好由 Android 开发工节程师生成, 生成方式见附录 settype Type 否取值为 (Type._url Type._payload Type._intent), 如果设置了 payload url intent, 需要指定 Type 对应的类型 l NotificationTemplate 成员方法名成员类型成员长度必填说明 setappid 是设定接收的应用 setappkey 是用于鉴定身份是否合法 settitle 40 中 / 英字符是通知标题 settext 600 中 / 英字符是通知内容 setlogo 40 中 / 英字符是通知的图标名称, 包含后缀名 ( 需要在客户端开发时嵌入 ), 如 push.png setisring boolean 否收到通知是否响铃 :true 响铃, false 不响铃默认响铃

26 setisvibrate boolean 否 setisclearable boolean 否 settransmissionconten 2048 中 / 英 t 字符是 settransmissiontype int 4byte 是收到通知是否振动 :true 振动, false 不振动默认振动通知是否可清除 :true 可清除, false 不可清除默认可清除透传内容, 不支持转义字符收到消息是否立即启动应用 :1 为立即启动,2 则广播等待客户端自启动 l LinkTemplate 成员方法名成员类型成员长度必填说明 setappid 是设定接收的应用 setappkey 是用于鉴定身份是否合法 settitle 40 中 / 英字符是通知标题 settext 600 中 / 英字符是通知内容 setlogo 40 中 / 英字符是通知的图标名称, 包含后缀名 ( 需要在客户端开发时嵌入 ), 如 push.png setisring boolean 否 setisvibrate boolean 否 setisclearable boolean 否收到通知是否响铃 :true 响铃, false 不响铃默认响铃收到通知是否振动 :true 振动, false 不振动默认振动通知是否可清除 :true 可清除, false 不可清除默认可清除 seturl 200 中 / 英字符是点击通知后打开的网页地址

27 l PopupTransmissionTemplate 成员方法名成员类型成员长度必填说明 setappid 是设定接收的应用 setappkey 是用于鉴定身份是否合法 settitle 40 中 / 英字符是弹框标题 settext 256 中 / 英字符是弹框内容 setimg 200 中 / 英字符否弹框图片 url setconfirmbuttontext 4 中 / 英字符是弹框确认按钮名称 setcancelbuttontext 4 中 / 英字符是弹框取消按钮名称 2048 中 / settransmissioncontent 是英字符 settransmissiontype int 4byte 是透传内容, 不支持转义字符收到消息是否立即启动应用 :1 为立即启动,2 则广播等待客户端自启动

28 附 : 1. pushmessagetolist 四种推送消息模板例程 1.1 TransmissionTemplate( 透传消息模板 ) Demo:PushMessageToListTransmissionTemplateTest 1.2 NotificationTemplate( 点击通知启动应用 ) Demo:PushMessageToListNotificationTemplateTest 1.3 LinkTemplate( 点击通知打开网页 ) Demo:PushMessageToListLinkTemplateTest 1.4 PopupTransmissionTemplate( 弹框通知启动应用 ) Demo:PushMessageToPopupTransmissionTemplateTest

29 附 :Andriod 开发工程师生成 intent 参考 // startintent 支持打开本应用内任意 activity // 格式如下 : intent:#intent;component= 你的包名 / 你要打开的 activity 全路径 ;S.parm1=value1;S.parm2=value2;end // 其中 parm: 如果你希望在 Intent URI 中携带数据, 注意一个限制 :Intent.toUri(Intent.URI_INTENT_SCHEME) // 返回的结果不会携带除基本类型 (boolean, byte, short, int, long, float, double, ) 以外的数据类型, 例如数组和 HashMap // 要打开的页面, 比如点击通知后跳转到当前 app 那个 activity, 若包名跟 activity 前缀包名不一致, 要传全路径 // 例如 : 以下为打开 MainActivity 传给该 activity 参数, 类型支持以下类型 // 当前应用包名不一定是 com.getui.demo, 但是 MainActivity 全路径是 com.getui.demo.mainactivity.class 要传全路径 Intent intent = new Intent(this, com.getui.demo.mainactivity.class); // int intent.putextra("parm1", 12); // float double intent.putextra("parm2", 13.5f); // byte intent.putextra("parm3", (byte) 3); // long intent.putextra("parm4", L); // short intent.putextra("parm5", (short) 10); // string intent.putextra("parm6", "string 类型 "); // 添加 flag intent.addflags(intent.flag_activity_new_task); // 特殊 string intent.putextra("parm7", "body < > = *?! #"); // 当前 app 包名, 只能打开自己的 app intent.setpackage(getpackagename()); // intent.touri(intent.uri_intent_scheme) 这个结果作为 startintent 参数 Log.d(TAG, "intentstr = " + intent.touri(intent.uri_intent_scheme)); 结果如下 : intent:#intent;launchflags=0x ;package=com.pp.yl;component= 你的包名 /com.getui.demo.mainactivity;i.parm1=12;f.parm2=13.5;b.parm3=3;l.parm4= ;s.parm5=10;s.parm6=string%20%e7%b1%b B%E5%9E%8B;S.parm7=body%20%3C%20%3E%20%3D%20*%20%3F%20!%20%23;end // 务必注意 : 如果接入了华为推送, 华为手机上被打开的 activity 如 "MainActivity", AndroidManifest 中必须设置 android:exported="true", 否则无法启动你配置的 activity

集成推送平台 JAVA 版本 SDK JavaPushSdk 发布说明 ( 请使用最新版本 ) 中央仓库获取 MVN Repository 或者 Central Repository 直接下载获取 Java Server SDK 更新日志 [ ]V

集成推送平台 JAVA 版本 SDK JavaPushSdk 发布说明 ( 请使用最新版本 ) 中央仓库获取 MVN Repository 或者 Central Repository 直接下载获取 Java Server SDK 更新日志 [2017-12-06]V1.0.0.20171206 1.0.0 标准版定义推送服务 (IFlymeUpsPush) 调用该类实例的方法来推送消息, 构造函数说明如下