**极光推送Jpush(v3)服务端PHP版本的api脚本类

  1. 云栖社区>
  2. 博客>
  3. 正文

**极光推送Jpush(v3)服务端PHP版本的api脚本类

suboysugar 2015-04-08 17:16:00 浏览563
展开阅读全文

关于极光推送的上一篇文章已经说明了,此处就不多说了。使用v3版本的原因是v2使用到2014年年底就停止了。点击查看上一篇的地址 http://www.dodobook.net/php/777 欢迎移步浏览。

昨天才开始拿到极光推送的SDK下载文档。下载地址 http://docs.jpush.cn/display/dev/Server-SDKs 看了半天也看出眉目。安装example的方法试了,各种报错。还需要vendor/autoload.php composer的支持。

后来查找各种方法能实现了。但是感觉好庞大的一个包。且想封装成为一个类,几次尝试都失败。想想v2版本一个文件实现多好啊。

自己太笨了,网上找找到相关的文档。自己稍加改动,终于实现,一个类就在后端调用了。直接上代码:


<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

//
极光推送的类 //文档见:http://docs.jpush.cn/display/dev/Push-API-v3 /***使用示例 $pushObj = new Jpush(); //组装需要的参数 //$receive = 'all'; //全部 //$receive = array('tag'=>array('2401','2588','9527')); //标签 $receive = array('alias'=>array('93d78b73611d886a74*****88497f501')); //别名 $content = '这是一个测试的推送数据....测试....Hello World...'; $m_type = 'http'; $m_txt = 'http://www.iqujing.com/'; $m_time = '600'; //离线保留时间 //调用推送,并处理 $result = $pushObj->push($receive,$content,$m_type,$m_txt,$m_time); if($result){ $res_arr = json_decode($result, true); if(isset($res_arr['error'])){ //如果返回了error则证明失败 echo $res_arr['error']['message']; //错误信息 echo $res_arr['error']['code']; //错误码 return false; }else{ //处理成功的推送...... echo '推送成功.....'; return true; } }else{ //接口调用失败或无响应 echo '接口调用失败或无响应'; return false; } ***/ class Jpush{ private $app_key = 'd7fd***********c3642fc'; //待发送的应用程序(appKey),只能填一个。 private $master_secret = 'a04**********4a80377'; //主密码 private $url = "https://api.jpush.cn/v3/push"; //推送的地址 //若实例化的时候传入相应的值则按新的相应值进行 public function __construct($app_key=null, $master_secret=null,$url=null) { if ($app_key) $this->app_key = $app_key; if ($master_secret) $this->master_secret = $master_secret; if ($url) $this->url = $url; } /* $receiver 接收者的信息 all 字符串 该产品下面的所有用户. 对app_key下的所有用户推送消息 tag(20个)Array标签组(并集): tag=>array('昆明','北京','曲靖','上海'); tag_and(20个)Array标签组(交集): tag_and=>array('广州','女'); alias(1000)Array别名(并集): alias=>array('93d78b73611d886a74*****88497f501','606d05090896228f66ae10d1*****310'); registration_id(1000)注册ID设备标识(并集): registration_id=>array('20effc071de0b45c1a**********2824746e1ff2001bd80308a467d800bed39e'); */ //$content 推送的内容。 //$m_type 推送附加字段的类型(可不填) http,tips,chat.... //$m_txt 推送附加字段的类型对应的内容(可不填) 可能是url,可能是一段文字。 //$m_time 保存离线时间的秒数默认为一天(可不传)单位为秒 public function push($receiver='all',$content='',$m_type='',$m_txt='',$m_time='86400'){ $base64=base64_encode("$this->app_key:$this->master_secret"); $header=array("Authorization:Basic $base64","Content-Type:application/json"); $data = array(); $data['platform'] = 'all'; //目标用户终端手机的平台类型android,ios,winphone $data['audience'] = $receiver; //目标用户 $data['notification'] = array( //统一的模式--标准模式 "alert"=>$content, //安卓自定义 "android"=>array( "alert"=>$content, "title"=>"", "builder_id"=>1, "extras"=>array("type"=>$m_type, "txt"=>$m_txt) ), //ios的自定义 "ios"=>array( // "alert"=>$content, "badge"=>"1", "sound"=>"default", // "extras"=>array("type"=>$m_type, "txt"=>$m_txt) ), ); //苹果自定义---为了弹出值方便调测 $data['message'] = array( "msg_content"=>$content, "extras"=>array("type"=>$m_type, "txt"=>$m_txt) ); //附加选项 $data['options'] = array( "sendno"=>time(), "time_to_live"=>$m_time, //保存离线时间的秒数默认为一天 "apns_production"=>1, //指定 APNS 通知发送环境:0开发环境,1生产环境。 ); $param = json_encode($data); $res = $this->push_curl($param,$header); if($res){ //得到返回值--成功已否后面判断 return $res; }else{ //未得到返回值--返回失败 return false; } } //推送的Curl方法 public function push_curl($param="",$header="") { if (empty($param)) { return false; } $postUrl = $this->url; $curlPost = $param; $ch = curl_init(); //初始化curl curl_setopt($ch, CURLOPT_URL,$postUrl); //抓取指定网页 curl_setopt($ch, CURLOPT_HEADER, 0); //设置header curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); //要求结果为字符串且输出到屏幕上 curl_setopt($ch, CURLOPT_POST, 1); //post提交方式 curl_setopt($ch, CURLOPT_POSTFIELDS, $curlPost); curl_setopt($ch, CURLOPT_HTTPHEADER,$header); // 增加 HTTP Header(头)里的字段 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); // 终止从服务端进行验证 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE); $data = curl_exec($ch); //运行curl curl_close($ch); return $data; } }

http://www.dodobook.net/php/780


极光推送Jpush(v3)服务端PHP版本集成(V3版本只调用推送API)

 因为版本升级,极光推送的API也有了V3,功能也更丰富了,但是对于我们有的用户来说,我们还是只需要调用推送的API就够了。

         下载了一份PHP服务端的SDK(下载地址:http://docs.jpush.io/resources/#sdk_1),然后我看蒙了。。。我们只需要推送,研究这个,花的时间也太长了一点吧!于是就到网上收集了看看有没有人集成一个类来调用的,这个特别感谢DoDobook的一个哥们儿额,参考他的我小改动了一下 就ok了!(他的博文http://www.dodobook.net/php/780)

       这里特意提醒各位,测试成不成功记得看管理平台上面的统计信息,因为之前把apns_production参数设置成了生产环境,调用接口成功,可是却没有用户,后来改为了开发环境,就成功了。

         

以下是代码区域:

<?php
class Jpush_send extends MY_Model {
        private $app_key = ‘314**************60191‘;        //待发送的应用程序(appKey),只能填一个。
        private $master_secret = ‘ab16a***********835c8862‘;    //主密码
        private $url = "https://api.jpush.cn/v3/push";      //推送的地址
    
        //若实例化的时候传入相应的值则按新的相应值进行
        public function __construct($app_key=null, $master_secret=null,$url=null) {
            if ($app_key) $this->app_key = $app_key;
            if ($master_secret) $this->master_secret = $master_secret;
            if ($url) $this->url = $url;
        }
        //极光推送的类
        //文档见:http://docs.jpush.cn/display/dev/Push-API-v3
        
        /**组装需要的参数
            $receive = ‘all‘;//全部
            $receive = array(‘tag‘=>array(‘2401‘,‘2588‘,‘9527‘));//标签
            $receive = array(‘alias‘=>array(‘93d78b73611d886a74*****88497f501‘));//别名
            $content = ‘这是一个测试的推送数据....测试....Hello World...‘;
            $m_type = ‘http‘;
            $m_txt = ‘http://www.iqujing.com/‘;
            $m_time = ‘600‘;        //离线保留时间
        **/
        //调用推送方法
        public function send_pub($receive,$content,$m_type,$m_txt,$m_time){
            $m_type = ‘http‘;//推送附加字段的类型
            $m_txt = ‘http://www.groex.cn/‘;//推送附加字段的类型对应的内容(可不填) 可能是url,可能是一段文字。
            $m_time = ‘86400‘;//离线保留时间
            
            $message="";//存储推送状态
            $result = $this->push($receive,$content,$m_type,$m_txt,$m_time);
            if($result){
                $res_arr = json_decode($result, true);
                if(isset($res_arr[‘error‘])){                       //如果返回了error则证明失败
                    echo $res_arr[‘error‘][‘message‘];          //错误信息
                    $error_code=$res_arr[‘error‘][‘code‘];             //错误码
                        switch ($error_code) {
                            case 200:
                                $message= ‘发送成功!‘;
                                break;
                            case 1000:
                                $message= ‘失败(系统内部错误)‘;
                                break;
                            case 1001:
                                $message = ‘失败(只支持 HTTP Post 方法,不支持 Get 方法)‘;
                                break;
                            case 1002:
                                $message= ‘失败(缺少了必须的参数)‘;
                                break;
                            case 1003:
                                $message= ‘失败(参数值不合法)‘;
                                break;
                            case 1004:
                                $message= ‘失败(验证失败)‘;
                                break;
                            case 1005:
                                $message= ‘失败(消息体太大)‘;
                                break;
                            case 1008:
                                $message= ‘失败(appkey参数非法)‘;
                                break;
                            case 1020:
                                $message= ‘失败(只支持 HTTPS 请求)‘;
                                break;
                            case 1030:
                                $message= ‘失败(内部服务超时)‘;
                                break;
                            default:
                                $message= ‘失败(返回其他状态,目前不清楚额,请联系开发人员!)‘;
                                break;
                        }
                }else{
                    $message="发送成功!";
                }
            }else{      //接口调用失败或无响应
                $message=‘接口调用失败或无响应‘;
            }
            echo  "<script>alert(‘推送信息:{$message}‘)</script>";
        }
        
    
        /*  $receiver 接收者的信息
         all 字符串 该产品下面的所有用户. 对app_key下的所有用户推送消息
        tag(20个)Array标签组(并集): tag=>array(‘昆明‘,‘北京‘,‘曲靖‘,‘上海‘);
        tag_and(20个)Array标签组(交集): tag_and=>array(‘广州‘,‘女‘);
        alias(1000)Array别名(并集): alias=>array(‘93d78b73611d886a74*****88497f501‘,‘606d05090896228f66ae10d1*****310‘);
        registration_id(1000)注册ID设备标识(并集): registration_id=>array(‘20effc071de0b45c1a**********2824746e1ff2001bd80308a467d800bed39e‘);
        */
        //$content 推送的内容。
        //$m_type 推送附加字段的类型(可不填) http,tips,chat....
        //$m_txt 推送附加字段的类型对应的内容(可不填) 可能是url,可能是一段文字。
        //$m_time 保存离线时间的秒数默认为一天(可不传)单位为秒
        public function push($receiver=‘all‘,$content=‘‘,$m_type=‘‘,$m_txt=‘‘,$m_time=‘86400‘){
            $base64=base64_encode("$this->app_key:$this->master_secret");
            $header=array("Authorization:Basic $base64","Content-Type:application/json");
            $data = array();
            $data[‘platform‘] = ‘all‘;          //目标用户终端手机的平台类型android,ios,winphone
            $data[‘audience‘] = $receiver;      //目标用户
             
            $data[‘notification‘] = array(
                    //统一的模式--标准模式
                    "alert"=>$content,
                     //安卓自定义
                    "android"=>array(
                            "alert"=>$content,
                            "title"=>"",
                            "builder_id"=>1,
                            "extras"=>array("type"=>$m_type, "txt"=>$m_txt)
                    ),
                    //ios的自定义
                    "ios"=>array(
                             "alert"=>$content,
                            "badge"=>"1",
                            "sound"=>"default",
                             "extras"=>array("type"=>$m_type, "txt"=>$m_txt)
                    )
            );
    
            //苹果自定义---为了弹出值方便调测
            $data[‘message‘] = array(
                    "msg_content"=>$content,
                    "extras"=>array("type"=>$m_type, "txt"=>$m_txt)
            );
    
            //附加选项
            $data[‘options‘] = array(
                    "sendno"=>time(),
                    "time_to_live"=>$m_time, //保存离线时间的秒数默认为一天
                    "apns_production"=>false, //布尔类型   指定 APNS 通知发送环境:0开发环境,1生产环境。或者传递false和true
            );
            $param = json_encode($data);
            $res = $this->push_curl($param,$header);
             
            if($res){       //得到返回值--成功已否后面判断
                return $res;
            }else{          //未得到返回值--返回失败
                return false;
            }
        }
    
        //推送的Curl方法
        public function push_curl($param="",$header="") {
            if (empty($param)) { return false; }
            $postUrl = $this->url;
            $curlPost = $param;
            $ch = curl_init();                                      //初始化curl
            curl_setopt($ch, CURLOPT_URL,$postUrl);                 //抓取指定网页
            curl_setopt($ch, CURLOPT_HEADER, 0);                    //设置header
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);            //要求结果为字符串且输出到屏幕上
            curl_setopt($ch, CURLOPT_POST, 1);                      //post提交方式
            curl_setopt($ch, CURLOPT_POSTFIELDS, $curlPost);
            curl_setopt($ch, CURLOPT_HTTPHEADER,$header);           // 增加 HTTP Header(头)里的字段
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);        // 终止从服务端进行验证
            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
            $data = curl_exec($ch);                                 //运行curl
            curl_close($ch);
            return $data;
        }
    
}
?>

 

如何联系我:【万里虎】www.bravetiger.cn 【QQ】3396726884 (咨询问题100元起,帮助解决问题500元起) 【博客】http://www.cnblogs.com/kenshinobiy/

网友评论

登录后评论
0/500
评论
suboysugar
+ 关注