JPush API PHP Library doc

JPush API PHP Library 提供简化构建JPush Push JSON的API，开发者只需要完成一下几个操作就能完成一次推送。

指定推送的平台(platform)
指定推送的用户(audience)
构建推送的notification或者message
指定额外的配置options
调用推送

版本更新

v3.1.2

examples中加入vendor.tar.gz，现在开发者直接解压此文件到项目目录，引入 vendor/autoload.php 既可以使用JPush。

添加了IOS推送中，支持badge +1， badge -1的操作

// badge 数值在原来的基础上+1
->setNotification(M\notification('Hi, JPush', M\ios("Hi, IOS", "happy", "+1")))
// badge 数值在原来的基础上-1
->setNotification(M\notification('Hi, JPush', M\ios("Hi, IOS", "happy", "-1")))
// badge 数值在原来的基础上+5
->setNotification(M\notification('Hi, JPush', M\ios("Hi, IOS", "happy", "+5")))

依赖

PHP >= 5.3

Dependencies

Composer
Httpful
Monolog

Development Dependencies

PHPUnit

About Log

请确保当前用户对日志文件夹有读写权限。

Example

以下的示例推送一个广播通知给所有用户

require_once 'vendor/autoload.php';

use JPush\Model as M;
use JPush\JPushClient;
use JPush\Exception\APIConnectionException;
use JPush\Exception\APIRequestException;

$br = '<br/>';
$client = new JPushClient($app_key, $master_secret);

try {
    $result = $client->push()
        ->setPlatform(M\all)
        ->setAudience(M\all)
        ->setNotification(M\notification('Hi, JPush'))
        ->send();
    echo 'Push Success.' . $br;
    echo 'sendno : ' . $result->sendno . $br;
    echo 'msg_id : ' .$result->msg_id . $br;
    echo 'Response JSON : ' . $result->json . $br;
} catch (APIRequestException $e) {
    echo 'Push Fail.' . $br;
    echo 'Http Code : ' . $e->httpCode . $br;
    echo 'code : ' . $e->code . $br;
    echo 'message : ' . $e->message . $br;
    echo 'Response JSON : ' . $e->json . $br;
    echo 'rateLimitLimit : ' . $e->rateLimitLimit . $br;
    echo 'rateLimitRemaining : ' . $e->rateLimitRemaining . $br;
    echo 'rateLimitReset : ' . $e->rateLimitReset . $br;
} catch (APIConnectionException $e) {
    echo 'Push Fail.' . $br;
    echo 'message' . $e->getMessage() . $br;
}

以上所有的推送对象构建器，都在 namespace： JPush\Model 中

use JPush\Model as M;

以下的示例获取特定ID的统计信息

require_once 'vendor/autoload.php';

use JPush\Model as M;
use JPush\JPushClient;
use JPush\Exception\APIConnectionException;
use JPush\Exception\APIRequestException;

$br = '<br/>';

$client = new JPushClient($app_key, $master_secret);

try {
    $msg_ids = '1931816610,1466786990,1931499836';
    $result = $client->report($msg_ids);
    foreach($result->received_list as  $received) {
        echo '---------' . $br;
        echo 'msg_id : ' . $received->msg_id . $br;
        echo 'android_received : ' .  $received->android_received . $br;
        echo 'ios_apns_sent : ' .  $received->ios_apns_sent . $br;
    }
} catch (APIRequestException $e) {
    echo 'Push Fail.' . $br;
    echo 'Http Code : ' . $e->httpCode . $br;
    echo 'code : ' . $e->code . $br;
    echo 'message : ' . $e->message . $br;
    echo 'Response JSON : ' . $e->json . $br;
    echo 'rateLimitLimit : ' . $e->rateLimitLimit . $br;
    echo 'rateLimitRemaining : ' . $e->rateLimitRemaining . $br;
    echo 'rateLimitReset : ' . $e->rateLimitReset . $br;
} catch (APIConnectionException $e) {
    echo 'Push Fail.' . $br;
    echo 'message' . $e->getMessage() . $br;
}

Payload Selectors

JPush Push JSON Model， JPush API v3中，每一个推送对象都是一个JSON对象。其具体结构可以参考推送对象
为了开发者更方便构建推送对象，本library提供以下方法：

function: JPush/Model/send()

将本payload对象推送到JPUSH服务器
返回：PushResponse 服务器响应对象

属性	类型	说明
$sendno	int	开发者指定的 API 调用标识
$msg_id	long	推送信息的唯一标示
$json	string	返回的JSON字符串
$response	object	返回的response

function: JPush/Model/getJSON()

获取当前payload对象的JSON字符串，仅供调试使用
返回：String JSON字符串

function: JPush/Model/printJSON()

打印当前JSON字符串，仅供调试使用
返回：PushPayload 当前的payload对象

function: JPush/Model/setAudience()