消息推送方式

消息推送方式

1. 对单个用户推送消息

1.1 接口说明

接口名称 支持推送类型 说明
pushMessageToSingle 透传(payload)、点击通知启动应用、点击通知打开网页等 对单个用户(clientid)推送

正常推送不需要传requestId,如果发生异常重试时将requestId传入,具体用法详见示例代码

pushMessageToSingle(message, target, requestId)

1.2 pushMessageToSingle代码实例

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Google.ProtocolBuffers;
using com.gexin.rp.sdk.dto;
using com.igetui.api.openservice;
using com.igetui.api.openservice.igetui;
using com.igetui.api.openservice.igetui.template;
using System.Net;

namespace GetuiServerApiSDKDemo
{
    public class demo
    {

        //采用"C# SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置,用户可自行替换
        private static String APPID = "aK6jeksP5C7CsjSSEqLAA311";     
        private static String APPKEY = "tpDVam96sY8pxhwBupJ462";                         
        private static String MASTERSECRET = "TBokfpttQJ6aHIhBE9y867";              
        //您获取的clientID
        private static String CLIENTID = "aadaf59782dcba2ca6083e4a47e895f7";    
        //别名推送方式
        //private static String ALIAS = "";
        //HOST:OpenService接口地址
        private static String HOST = "http://sdk.open.api.igexin.com/apiex.htm";    

        static void Main(string[] args)
        {
            //toList接口每个用户状态返回是否开启,可选
            Console.OutputEncoding = Encoding.GetEncoding(936);
            Environment.SetEnvironmentVariable("needDetails", "true");


            PushMessageToSingle();
        }

        private static void PushMessageToSingle()
       {

           IGtPush push = new IGtPush(HOST,APPKEY, MASTERSECRET);

           //消息模版:TransmissionTemplate:透传模板

           TransmissionTemplate template =  TransmissionTemplateDemo();


           // 单推消息模型
           SingleMessage message = new SingleMessage();
           message.IsOffline = true;                         // 用户当前不在线时,是否离线存储,可选
           message.OfflineExpireTime = 1000 * 3600 * 12;            // 离线有效时间,单位为毫秒,可选
           message.Data = template;
           //判断是否客户端是否wifi环境下推送,2为4G/3G/2G,1为在WIFI环境下,0为不限制环境
           //message.PushNetWorkType = 1;  

           com.igetui.api.openservice.igetui.Target target = new com.igetui.api.openservice.igetui.Target();
           target.appId = APPID;
           target.clientId = CLIENTID;
           //target.alias = ALIAS;
           try
           {
               String pushResult = push.pushMessageToSingle(message, target);

               System.Console.WriteLine("-----------------------------------------------");
               System.Console.WriteLine("-----------------------------------------------");
               System.Console.WriteLine("----------------服务端返回结果:" + pushResult);
           }
           catch (RequestException e)
           {
               String requestId=e.RequestId;
               //发送失败后的重发
               String pushResult = push.pushMessageToSingle(message, target, requestId);
               System.Console.WriteLine("-----------------------------------------------");
               System.Console.WriteLine("-----------------------------------------------");
               System.Console.WriteLine("----------------服务端返回结果:" + pushResult);
           }
       }


       //透传模板动作内容
        public  static TransmissionTemplate TransmissionTemplateDemo()
        {
            TransmissionTemplate template = new TransmissionTemplate();
            template.AppId = APPID;
            template.AppKey = APPKEY;
            //应用启动类型,1:强制应用启动 2:等待应用启动
            template.TransmissionType = "1";      
            //透传内容  
            template.TransmissionContent = "透传内容";  
            //设置通知定时展示时间,结束时间与开始时间相差需大于6分钟,消息推送后,客户端将在指定时间差内展示消息(误差6分钟)
            String begin = "2015-03-06 14:36:10";
            String end = "2015-03-06 14:46:20";
            template.setDuration(begin, end);

            return template;
        }
    }
}

1.3 返回值

字段 返回码
result 请查询返回值
客户端展示

2. 对指定列表用户推送消息

如果仅对单个用户推送务必使用单推接口,否则会严重影响推送性能,如果对少量甚至几个用户推送同样的消息,建议使用单推实现,性能会更高

2.1 接口说明

接口名称 支持推送类型 说明
pushMessageToList 透传(payload)、点击通知启动应用、点击通知打开网页等 (通过ClientID列表)群推,可查看clientid列表中每个用户的在线状态

2.2 pushMessageToList代码实例

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Google.ProtocolBuffers;
using com.gexin.rp.sdk.dto;
using com.igetui.api.openservice;
using com.igetui.api.openservice.igetui;
using com.igetui.api.openservice.igetui.template;
using System.Net;

namespace GetuiServerApiSDKDemo
{
    public class demo
    {

        //采用"C# SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置,用户可自行替换
        private static String APPID = "aK6jeksP5C7CsjSSEqLAA311";     
        private static String APPKEY = "tpDVam96sY8pxhwBupJ462";                         
        private static String MASTERSECRET = "TBokfpttQJ6aHIhBE9y867";              
        //您获取的clientID
        private static String CLIENTID1 = "aadaf59782dcba2ca6083e4a47e895f7";  
        private static String CLIENTID2 = "aadaf59782dcba2ca6083e4a47e895f8";
        //别名推送方式
        //private static String ALIAS1 = "";  
        //private static String ALIAS2 = "";
        //HOST:OpenService接口地址
        private static String HOST = "http://sdk.open.api.igexin.com/apiex.htm";    

        static void Main(string[] args)
        {
            //toList接口每个用户状态返回是否开启,可选
            Console.OutputEncoding = Encoding.GetEncoding(936);
            Environment.SetEnvironmentVariable("needDetails", "true");

            //2.PushMessageToList接口
            PushMessageToList();
        }

        //PushMessageToList接口测试代码
        private static void PushMessageToList()
        {
            // 推送主类(方式1,不可与方式2共存)
            IGtPush push = new IGtPush(HOST, APPKEY, MASTERSECRET);
            // 推送主类(方式2,不可与方式1共存)此方式可通过获取服务端地址列表判断最快域名后进行消息推送,每10分钟检查一次最快域名
            //IGtPush push = new IGtPush("",APPKEY,MASTERSECRET);
            ListMessage message = new ListMessage();

            NotificationTemplate template =  NotificationTemplateDemo();
            // 用户当前不在线时,是否离线存储,可选
            message.IsOffline = true;                        
            // 离线有效时间,单位为毫秒,可选
            message.OfflineExpireTime = 1000 * 3600 * 12;           
            message.Data = template;
            //message.PushNetWorkType = 0;        //判断是否客户端是否wifi环境下推送,1为在WIFI环境下,0为不限制网络环境。
            //设置接收者
            List<com.igetui.api.openservice.igetui.Target> targetList = new List<com.igetui.api.openservice.igetui.Target>();
            com.igetui.api.openservice.igetui.Target target1 = new com.igetui.api.openservice.igetui.Target();
            target1.appId = APPID;
            target1.clientId = CLIENTID1;
            //target1.alias = ALIAS1;

            // 如需要,可以设置多个接收者
            com.igetui.api.openservice.igetui.Target target2 = new com.igetui.api.openservice.igetui.Target();
            target2.appId = APPID;
            target2.clientId = CLIENTID2;
            //target2.alias = ALIAS2;

            targetList.Add(target1);
            targetList.Add(target2);

            String contentId = push.getContentId(message);
            String pushResult = push.pushMessageToList(contentId, targetList);
            System.Console.WriteLine("-----------------------------------------------");
            System.Console.WriteLine("服务端返回结果:" + pushResult);
        }


        //通知透传模板动作内容
        public static NotificationTemplate NotificationTemplateDemo()
        {
            NotificationTemplate template = new NotificationTemplate();
            template.AppId = APPID;
            template.AppKey = APPKEY;
            //通知栏标题
            template.Title = "请填写通知标题";     
            //通知栏内容     
            template.Text = "请填写通知内容";          
            //通知栏显示本地图片
            template.Logo = "";               
            //通知栏显示网络图标
            template.LogoURL = "";                    
            //应用启动类型,1:强制应用启动  2:等待应用启动
            template.TransmissionType = "1";        
            //透传内容  
            template.TransmissionContent = "请填写透传内容";  
            //接收到消息是否响铃,true:响铃 false:不响铃   
            template.IsRing = true;        
            //接收到消息是否震动,true:震动 false:不震动   
            template.IsVibrate = true;         
            //接收到消息是否可清除,true:可清除 false:不可清除    
            template.IsClearable = true;
            //设置通知定时展示时间,结束时间与开始时间相差需大于6分钟,消息推送后,客户端将在指定时间差内展示消息(误差6分钟)
            String begin = "2015-03-06 14:36:10";
            String end = "2015-03-06 14:46:20";
            template.setDuration(begin, end);

            return template;
        }
    }
}

2.3 返回值

字段 返回码
result 请查询返回值
客户端展示

注:此接口有频次控制,申请修改请联系邮箱:kegf@getui.com

3. 对指定应用群推送消息

3.1 接口说明

接口名称 支持推送类型 说明
pushMessageToApp 透传(payload)、点击通知启动应用、点击通知打开网页等 (通过应用AppID)群推,给所有符合条件的客户端用户推送

3.2 pushMessageToApp代码实例

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Google.ProtocolBuffers;
using com.gexin.rp.sdk.dto;
using com.igetui.api.openservice;
using com.igetui.api.openservice.igetui;
using com.igetui.api.openservice.igetui.template;
using System.Net;

namespace GetuiServerApiSDKDemo
{
    public class demo {

        //采用"C# SDK 快速入门", "第二步 获取访问凭证 "中获得的应用配置,用户可自行替换
        private static String APPID = "aK6jeksP5C7CsjSSEqLAA311";   
        private static String APPKEY = "tpDVam96sY8pxhwBupJ462";  
        private static String MASTERSECRET = "TBokfpttQJ6aHIhBE9y867";
         //您获取的clientID
        private static String CLIENTID = "aadaf59782dcba2ca6083e4a47e895f7";  
        //HOST:OpenService接口地址  
        private static String HOST = "http://sdk.open.api.igexin.com/apiex.htm";    

        static void Main(string[] args){
            //3.pushMessageToApp接口
            pushMessageToApp();
        }
        //pushMessageToApp接口测试代码
        private static void pushMessageToApp(){
            // 推送主类(方式1,不可与方式2共存)
            IGtPush push = new IGtPush(HOST, APPKEY, MASTERSECRET);
            // 推送主类(方式2,不可与方式1共存)此方式可通过获取服务端地址列表判断最快域名后进行消息推送,每10分钟检查一次最快域名
            //IGtPush push = new IGtPush("",APPKEY,MASTERSECRET);

            AppMessage message = new AppMessage();

            // 设置群推接口的推送速度,单位为条/秒,仅对pushMessageToApp(对指定应用群推接口)有效
            message.Speed = 100;

            TransmissionTemplate template =  TransmissionTemplateDemo();

            // 用户当前不在线时,是否离线存储,可选
            message.IsOffline = false;            
            // 离线有效时间,单位为毫秒,可选  
            message.OfflineExpireTime = 1000 * 3600 * 12;            
            message.Data = template;
            //message.PushNetWorkType = 0;        //判断是否客户端是否wifi环境下推送,1为在WIFI环境下,0为不限制网络环境。
            List<String> appIdList = new List<string>();
            appIdList.Add(APPID);

             //通知接收者的手机操作系统类型
            List<String> phoneTypeList = new List<string>();   
                    phoneTypeList.Add("ANDROID");
                    phoneTypeList.Add("IOS");
             //通知接收者所在省份
            List<String> provinceList = new List<string>();     
                    provinceList.Add("浙江");
                    provinceList.Add("上海");
                    provinceList.Add("北京");

            List<String> tagList = new List<string>();
                    tagList.Add("开心");

            message.AppIdList = appIdList;
            message.PhoneTypeList = phoneTypeList;
            message.ProvinceList = provinceList;
            message.TagList = tagList;


            String pushResult = push.pushMessageToApp(message);
            System.Console.WriteLine("-----------------------------------------------");
            System.Console.WriteLine("服务端返回结果:" + pushResult);
        }
        //透传模板动作内容
        public  static TransmissionTemplate TransmissionTemplateDemo()
        {
            TransmissionTemplate template = new TransmissionTemplate();
            template.AppId = APPID;
            template.AppKey = APPKEY;
            //应用启动类型,1:强制应用启动 2:等待应用启动
            template.TransmissionType = "1";      
            //透传内容  
            template.TransmissionContent = "透传内容";  
            //设置通知定时展示时间,结束时间与开始时间相差需大于6分钟,消息推送后,客户端将在指定时间差内展示消息(误差6分钟)
            String begin = "2015-03-06 14:36:10";
            String end = "2015-03-06 14:46:20";
            template.setDuration(begin, end);

            return template;
        }
    }
}

3.3 返回值

字段 返回码
result 请查询返回值
客户端展示

注:此接口有频次控制,申请修改请联系邮箱:kegf@getui.com

4. 任务组名推送

4.1 描述

一个应用同时下发了n个推送任务,为了更好地跟踪这n个任务的推送效果,可以把他们组成一个任务组,在查询数据时,只需要输入该任务组名即可同时查到n个任务的数据结果。

4.2 应用场景

  • 场景:做AB test,分别下发A组、B组推送任务,将A、B任务建成“任务组1”,查数据时,仅需要查找任务组1,即可以一起看到A、B两组测试的结果,可以更直观地对比数据。

4.3 对应接口

命名同一个应用的不同taskid为同一个任务组名,任务组名由第三方填写。tolist(对指定用户列表推送消息)、toapp(对指定应用群推消息)接口支持该功能。

4.3.1 Tolist接口代码实例

public void toListGroupName(string host, string appkey, string mastersecret, string taskGroupName, ListMessage msg)
{
    IGtPush push = new IGtPush(host, appkey, mastersecret);
    string contentId = push.getContentId(msg, taskGroupName);
}

4.3.2 Toapp接口代码实例

public void toAppGroupName(string host, string appkey, string mastersecret, string taskGroupName, AppMessage msg)
{
    IGtPush push = new IGtPush(host, appkey, mastersecret);
    push.pushMessageToApp(msg, taskGroupName);
}

5. 批量单推功能

5.1 描述

用于一次创建提交多个单推任务。

5.2应用场景

当单推任务较多时,推荐使用该接口,可以减少与服务端的交互次数。

5.3 对应接口

函数说明:

接口定义 说明
add($message, $target) 追加单推消息
submit() 提交消息
retry() 重新提交

参数说明:

推送参数message和target与对单个用户推送消息使用的的参数相同

推送返回值:

批量单推每个单推消息的返回结果在submit返回值的info字段中,具体为加入时的序号和对应的返回结果。返回值详情请点击Result返回值

代码实例:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Google.ProtocolBuffers;
using com.gexin.rp.sdk.dto;
using com.igetui.api.openservice;
using com.igetui.api.openservice.igetui;
using com.igetui.api.openservice.igetui.template;
using System.Net;

public static void singleBatchDemo()
{
    IGtPush push = new IGtPush(HOST, APPKEY, MASTERSECRET);
    IBatch batch = new BatchImpl(APPKEY, push);
                //消息模版:TransmissionTemplate:透传模板
    TransmissionTemplate templateTrans = TransmissionTemplateDemo();

    // 单推消息模型
    SingleMessage messageTrans = new SingleMessage();
    messageTrans.IsOffline = true;                         // 用户当前不在线时,是否离线存储,可选
    messageTrans.OfflineExpireTime = 1000 * 3600 * 12;            // 离线有效时间,单位为毫秒,可选
    messageTrans.Data = templateTrans;
    //判断是否客户端是否wifi环境下推送,2为4G/3G/2G,1为在WIFI环境下,0为不限制环境
    //messageTrans.PushNetWorkType = 1;  

    com.igetui.api.openservice.igetui.Target targetTrans = new com.igetui.api.openservice.igetui.Target();
    targetTrans.appId = APPID;
    targetTrans.clientId = CLIENTID1;
    batch.add(messageTrans, targetTrans);

     NotificationTemplate templateNoti = NotificationTemplateDemo();

    // 单推消息模型
    SingleMessage messageNoti = new SingleMessage();
    messageNoti.IsOffline = true;                         // 用户当前不在线时,是否离线存储,可选
    messageNoti.OfflineExpireTime = 1000 * 3600 * 12;            // 离线有效时间,单位为毫秒,可选
    messageNoti.Data = templateNoti;
    //判断是否客户端是否wifi环境下推送,2为4G/3G/2G,1为在WIFI环境下,0为不限制环境
    //messageNoti.PushNetWorkType = 1;  

    com.igetui.api.openservice.igetui.Target targetNoti = new com.igetui.api.openservice.igetui.Target();
    targetNoti.appId = APPID;
    targetNoti.clientId = CLIENTID2;
    batch.add(messageNoti, targetNoti);
    try
    {
        batch.submit();
    } catch(Exception e)
    {
        batch.retry();
    }
}
//透传模板动作内容
public static TransmissionTemplate TransmissionTemplateDemo()
{
    TransmissionTemplate template = new TransmissionTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
    //应用启动类型,1:强制应用启动 2:等待应用启动
    template.TransmissionType = "1";
    //透传内容  
    template.TransmissionContent = "透传内容";
    //设置通知定时展示时间,结束时间与开始时间相差需大于6分钟,消息推送后,客户端将在指定时间差内展示消息(误差6分钟)
    String begin = "2016-11-10 18:00:00";
    String end = "2016-11-10 22:46:20";
    template.setDuration(begin, end);

    return template;
}

 //通知透传模板动作内容
public static NotificationTemplate NotificationTemplateDemo()
{
    NotificationTemplate template = new NotificationTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
    //通知栏标题
    template.Title = "请填写通知标题";
    //通知栏内容     
    template.Text = "请填写通知内容";
    //通知栏显示本地图片
    template.Logo = "";
    //通知栏显示网络图标
    template.LogoURL = "";
    //应用启动类型,1:强制应用启动  2:等待应用启动
    template.TransmissionType = "1";
    //透传内容  
    template.TransmissionContent = "请填写透传内容";
    //接收到消息是否响铃,true:响铃 false:不响铃   
    template.IsRing = true;
    //接收到消息是否震动,true:震动 false:不震动   
    template.IsVibrate = true;
    //接收到消息是否可清除,true:可清除 false:不可清除    
    template.IsClearable = true;
    //设置通知定时展示时间,结束时间与开始时间相差需大于6分钟,消息推送后,客户端将在指定时间差内展示消息(误差6分钟)
    String begin = "2015-03-06 14:36:10";
    String end = "2015-03-06 14:46:20";
    template.setDuration(begin, end);

    return template;
}

6. PushResult返回值查询

具体返回值请查询下表

正确返回 返回码 结果说明
successed_online 用户在线,消息在线下发
successed_offline 用户离线,消息存入离线系统
Ok 发送成功
details 返回用户状态的详细信息
contentId 任务ID(当result值为ok时,有此字段)
错误返回 返回码 结果说明
Error 请求信息填写有误
action_error 未找到对应的action动作
appkey_error Appkey填写错误
domain_error 填写的域名错误或者无法解析
sign_error Appkey与ClientId不匹配,鉴权失败
AppidNoMatchAppKey appid和鉴权的appkey不匹配
PushMsgToListOrAppTimesOverLimit 群推次数超过最大值
PushTotalNumOverLimit 推送个数总数超过最大值
AppIdNoUsers 该AppId下的用户总数为0
SendError 消息推送发送错误
SynSendError 报文发送错误
flow_exceeded 接口消息推送流量已超限
TargetListIsNullOrSizeIs0 推送target列表为空
PushTotalNumOverLimit 推送消息个数总数超限
TokenMD5NoUsers target列表没有有效的clientID
NullMsgCommon 未找到contentId对应的任务
TaskIdHasBeanCanceled 任务已经被取消
AppidError clientid绑定的appid与推送的appid不符
successed_ignore 无效用户,消息丢弃
TokenMD5Error clientID填写有误
SendError 消息发送错误
AppidNoAppSecret appid未找到对应的appSecret
OtherError 未知错误,无法判定错误类型
通知
2018.08.09 PHP SDK 4.0.1.10

添加php新加接口功能文档说明

......
2018.07.19 Android SDK 4.3.1.0

增加Applink点击回执接口 修复若干其他bug以及性能优化

......
2018.06.19 iOS SDK 2.3.0.0

新增 AppLink 服务及统计支持。 新增短信补量推送服务。

......
2018.06.19 Android SDK 2.12.4.0

增加Applink点击回执接口 修复若干其他bug以及性能优化

......
2018.03.21 Android SDK 4.3.0.0

增加通知到达、点击回调 适配Android 8.0 修复若干其他bug

......

文档中心搜索