platx/pushall

dev-master 2016-01-28 10:34 UTC

README

This is php client for PushAll.ru API, helps to send push messages via this service.

Usage

1.In your php file type this:

    require {dir}.'/pushall/PushAll.php';

Where {dir} - full server path to a directory with our pushall folder.

2.Then you must to initialize PushAll client with following code:

    /**
     * Client initialization
     */
    $pushAll = new PushAll(
        00000, 
        'aaa000bbb111ccc222ddd333eee444ff'
    );

Where 00000 - your feed id, aaa000bbb111ccc222ddd333eee444ff - your feed key.

3.To send a push message use following code:

    /**
     * Send a message
     */
    $result = $pushAll->send(array(
        'type' => PushAll::TYPE_SELF,
        'title' => 'some title',
        'text' => 'some message'
    ));

Initialization parameters

Parameter Type Required Default Variants
id integer YES - -
key string YES - -
responseType string NO 0 0, 1 OR RESPONSE_TYPE_JSON, RESPONSE_TYPE_ARRAY

List of parameters

Parameter Type Required Default Variants
type string YES self self, broadcast, unicast, multicast OR TYPE_SELF, TYPE_BROADCAST, TYPE_UNICAST, TYPE_MULTICAST
uid integer NO - -
title string YES - -
text string YES - -
url string NO - -
hidden integer NO 0 0, 1, 2 OR HIDDEN_FALSE, HIDDEN_HISTORY, HIDDEN_BAND
encode string NO UTF-8 -
priority integer NO 0 -1, 0, 1 OR PRIORITY_NOT_IMPORTANT, PRIORITY_DEFAULT, PRIORITY_IMPORTANT
responseType integer NO 0 0, 1 OR RESPONSE_TYPE_JSON, RESPONSE_TYPE_ARRAY