此SDK已停止维护，请开发者对接 RestApi V2

推送模板说明

简述

开发者可设置推送展示效果，分为通知样式和后续操作。

推送效果：

• 通知消息：

通知展示时效果：响铃、震动、通知是否可清除。

通知点击后效果：打开应用首页、打开应用内指定页面、打开浏览器指定网页。

• 透传消息：

即自定义消息，效果由开发者自行管理，个推只负责消息传递，不做任何处理，APP在接收到透传消息后可按自身需求处理消息的展示方式或后续动作。

设置步骤

STEP1：选择合适的推送模板，决定后续操作。

STEP2：设置推送其他参数

STEP3：执行推送

示例说明

    // STEP1：选择模板
    $template =  new IGtNotificationTemplate();
    // 设置APPID与APPKEY    
    $template->set_appId(APPID);//应用appid
    $template->set_appkey(APPKEY);//应用appkey
    //设置模板参数
    $template->set_transmissionType(1);//透传消息类型
    $template->set_transmissionContent("测试离线");//透传内容
    $template->set_title("请输入通知栏标题");//通知栏标题
    $template->set_text("请输入通知栏内容");//通知栏内容
    $template->set_logo("http://wwww.igetui.com/logo.png");//通知栏logo
    $template->set_isRing(true);//是否响铃
    $template->set_isVibrate(true);//是否震动
    $template->set_isClearable(true);//通知栏是否可清除    

    // STEP2：设置推送其他参数
    $message = new IGtSingleMessage();
    $message->set_isOffline(true);
    $message->set_offlineExpireTime(60 * 60 * 1000);
    $message->set_data($template);

    $target = new IGtTarget();
    $target->set_appId("APPID");
    $target->set_clientId("CID");

    // STEP3：执行推送
    $ret = $igt->pushMessageToSingle($message, $target);

【透传模板】自定义消息

描述

透传消息是指消息传递到客户端只有消息内容，展现形式由客户端自行定义。客户端可自定义通知的展现形式，也可自定义通知到达之后的动作，或者不做任何展现。

对应模板（TransmissionTemplate）

参数说明

代码示例

function IGtTransmissionTemplateDemo(){
    $template =  new IGtTransmissionTemplate();
    //应用appid
    $template->set_appId(APPID);
    //应用appkey
    $template->set_appkey(APPKEY);
    //透传消息类型
    $template->set_transmissionType(1);
    //透传内容
    $template->set_transmissionContent("测试离线");
    //$template->set_duration(BEGINTIME,ENDTIME); //设置ANDROID客户端在此时间区间内展示消息
    //这是老方法，新方法参见iOS模板说明(PHP)*/
    //$template->set_pushInfo("actionLocKey","badge","message",
    //"sound","payload","locKey","locArgs","launchImage");
    return $template;
}

iOS推送说明

iOS推送需要在代码中通过TransmissionTemplate的setAPNInfo接口设置相应的APNs通知参数。
透传模板传输的数据最大为是3KB，APNs传输数据最大支持3KB。

对应接口

set_apnInfo($apn)

参数描述：

set_apnInfo具体参数含义详见苹果APNs文档：
https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html
注：AutoBadge、AlertMsg、Sound(不设置无声)必须至少设置一项

参数说明：

• VoIP推送

代码示例：

function IGtTransmissionTemplateDemo(){
    $template =  new IGtTransmissionTemplate();
    $template->set_appId(APPID);//应用appid
    $template->set_appkey(APPKEY);//应用appkey
    $template->set_transmissionType(1);//透传消息类型
    $template->set_transmissionContent("测试离线ddd");//透传内容
    //$template->set_duration(BEGINTIME,ENDTIME); //设置ANDROID客户端在此时间区间内展示消息
    //APN简单推送
//  $template = new IGtAPNTemplate();
//  $apn = new IGtAPNPayload();
//  $alertmsg=new SimpleAlertMsg();
//  $alertmsg->alertMsg="";
//  $apn->alertMsg=$alertmsg;
//  $apn->badge=2;
//  $apn->sound="";
//  $apn->add_customMsg("payload","payload");
//  $apn->contentAvailable=0;
//  $apn->category="ACTIONABLE";
//  $template->set_apnInfo($apn);
//  $message = new IGtSingleMessage();
    //  APN高级推送
    $apn = new IGtAPNPayload();
    $alertmsg=new DictionaryAlertMsg();
    $alertmsg->body="body";
    $alertmsg->actionLocKey="ActionLockey";
    $alertmsg->locKey="LocKey";
    $alertmsg->locArgs=array("locargs");
    $alertmsg->launchImage="launchimage";
    //  IOS8.2 支持
    $alertmsg->title="Title";
    $alertmsg->titleLocKey="TitleLocKey";
    $alertmsg->titleLocArgs=array("TitleLocArg");
    $alertmsg->subtitle="subtitle";
    $alertmsg->subtitleLocKey="subtitleLocKey";
    $alertmsg->subtitleLocArgs=array("subtitleLocArgs");

    $apn->alertMsg=$alertmsg;
    $apn->badge=7;
    $apn->sound="";
    $apn->add_customMsg("payload","payload");
    //设置语音播报类型，int类型，0.不可用 1.播放body 2.播放自定义文本
    $apn->voicePlayType = 2;
    //设置语音播报内容，String类型，非必须参数，用户自定义播放内容，仅在voicePlayMessage=2时生效
    //注：当"定义类型"=2, "定义内容"为空时则忽略不播放
    $apn->voicePlayMessage = "定义内容";
    $apn->contentAvailable=0;
    $apn->category="ACTIONABLE";
    $apn->set_threadId("threadId");
    $sound_d = new Sound();
    $sound_d->set_name("name");
    $sound_d->set_critical(1);
    $sound_d->set_volume(0.5);
    $apn->set_sound_d($sound_d);
    //IOS多媒体消息处理
    $media = new IGtMultiMedia();
    $media -> set_url("http://docs.getui.com/start/img/pushapp_android.png");
    $media -> set_onlywifi(false);
    $media -> set_type(MediaType::pic);
    $medias = array();
    $medias[] = $media;
    //$apn->set_multiMedias($medias);
    $template->set_apnInfo($apn);

    return $template;
}

【通知模板】 打开应用首页

描述

在通知栏显示一条通知，用户点击后打开应用的首页。

应用场景

针对沉默用户，发送推送消息，点击消息栏的通知可直接激活启动应用，提升应用的转化率。

对应模板（NotificationTemplate）

参数说明

代码示例

function IGtNotificationTemplateDemo(){
    $template =  new IGtNotificationTemplate();
    $template->set_appId(APPID);                      //应用appid
    $template->set_appkey(APPKEY);                    //应用appkey
    $template->set_transmissionType(1);               //透传消息类型
    $template->set_transmissionContent("测试离线");   //透传内容
    $template->set_title("请填写通知标题");                     //通知栏标题
    $template->set_text("请填写通知内容");        //通知栏内容
    $template->set_logo("logo.png");                  //通知栏logo
    $template->set_logoURL("http://wwww.igetui.com/logo.png"); //通知栏logo链接
    $template->set_isRing(true);                      //是否响铃
    $template->set_isVibrate(true);                   //是否震动
    $template->set_isClearable(true);                 //通知栏是否可清除
    //$template->set_duration(BEGINTIME,ENDTIME); //设置ANDROID客户端在此时间区间内展示消息
    $template->set_channel("set_channel");
    $template->set_channelName("set_channelName");
    $template->set_channelLevel(3);
    $template->set_notifyId(12345678);
    return $template;
}

【通知模板】 打开浏览器网页

描述

在通知栏显示一条通知，用户点击可打开浏览器的指定网页。

应用场景

推广促销活动，用户点击通知栏信息，直接打开到指定的促销活动页面，推送直接到达指定页面，免去了中间过程的用户流失。

对应模板（LinkTemplate）

参数说明

代码示例

function IGtLinkTemplateDemo(){
    $template =  new IGtLinkTemplate();
    $template ->set_appId(APPID);                  //应用appid
    $template ->set_appkey(APPKEY);                //应用appkey
    $template ->set_title("请输入通知标题");       //通知栏标题
    $template ->set_text("请输入通知内容");        //通知栏内容
    $template->set_logo("");                       //通知栏logo
    $template->set_logoURL("");                    //通知栏logo链接
    $template ->set_isRing(true);                  //是否响铃
    $template ->set_isVibrate(true);               //是否震动
    $template ->set_isClearable(true);             //通知栏是否可清除
    $template ->set_url("http://www.igetui.com/"); //打开连接地址
    //$template->set_duration(BEGINTIME,ENDTIME); //设置ANDROID客户端在此时间区间内展示消息
    $template->set_channel("set_channel");
    $template->set_channelName("set_channelName");
    $template->set_channelLevel(3);
    $template->set_notifyId(12345678);
    return $template;
}

【通知模板】 打开应用内页面

描述

在通知栏显示一条通知，用户点击后打开应用内指定的页面。

应用场景

推广促销活动，用户点击通知栏信息，直接打开到应用内指定的促销活动页面。

对应模板（StartActivityTemplate）

参数说明

代码示例

function IGtStartActivityTemplateDemo(){
    $template = new IGtStartActivityTemplate();

    $template->set_appId(APPID);//应用appid
    $template->set_appkey(APPKEY);//应用appkey
    $template->set_intent("");
    $template->set_title("个推");//通知栏标题
    $template->set_text("个推最新版点击下载");//通知栏内容
    $template->set_logo("");//通知栏logo
    $template->set_logoURL("http://*");
    $template->set_isRing(true);//是否响铃
    $template->set_isVibrate(true);//是否震动
    $template->set_isClearable(true);//通知栏是否可清除
    //$template->set_duration("XXXX-XX-XX XX:XX:XX","XXXX-XX-XX XX:XX:XX");
    //$smsMessage = new SmsMessage();//设置短信通知
    //$smsMessage->setPayload("1234");
    //$smsMessage->setUrl("http://www/getui");
    //$smsMessage->setSmsTemplateId("123456789");
    //$smsMessage->setOfflineSendtime(1000);
    //$smsMessage->setIsApplink(true);
    //$template->setSmsInfo($smsMessage);
    $template->set_notifyId(123456543);
    return $template;
}

【通知模板】通知消息撤回

描述

消息撤回是指对已经发送的个推通道消息进行撤回。客户端接收到消息撤回的指令，会将通知栏中展示的消息进行删除，不再展示。

sdk版本要求

客户端sdk：2.12.5.0以上

服务端os-sdk：php 4.1.2.0以上

撤回使用限制

1. 支持任务类型：os-sdk撤回模板支持撤回单推、群推、toApp任务。
2. 支持模板：只支持撤回通知、不支持透传
3. Android只支持撤回个推通道下发的通知，通过手机厂商通道下发的通知不支持撤回

对应模板 （RevokeTemplate）

参数说明

代码示例

    function getRevokeTemplateDemo(){
        $revoke = new IGtRevokeTemplate();
        $revoke->set_appId("appid");
        $revoke->set_appkey("appkey");
        $revoke->set_oldTaskId("taskId");
        $revoke->set_force(false);
        return $revoke;
    }