Elibom PHP API Client

==========

A php client of the Elibom REST API. The full API reference is here

Requisites

cURL (apt-get install php5-curl)

Getting stared

1. Install

   pear install https://github.com/elibom/elibom-php/raw/master/download/ElibomClient-1.1.tgz

   or

   download sources files https://github.com/elibom/elibom-php/releases/download/1.1/ElibomSRC.zip and decompress in your project folder.

2. Create an ElibomRestClient object passing your credentials:

   require('elibom/elibom.php');
   use Elibom\APIClient\ElibomClient as ElibomClient;
   
   $elibom = new ElibomClient('your.email@domain','your_api_token');

   Note: You can find your api password at http://www.elibom.com/api-password (make sure you are logged in).

   You are now ready to start calling the API methods!

API Methods

• Send SMS
• Schedule SMS
• Show Delivery
• List Scheduled SMS Messages
• Show Scheduled SMS Message
• Cancel Scheduled SMS Message
• List Users
• Show User
• Show Account

Send SMS

//Return string
$deliveryId = $elibom->sendMessage('3201111111','PHP - TEST');

Send SMS with a campaign name

//Return string
$deliveryId = $elibom->sendMessage('3201111111','PHP - TEST', 'Campaign name');

Show Delivery

//Return json object
$delivery = $elibom->getDelivery('<delivery_token>');

Schedule SMS

//Return string
$scheduleId  = $elibom->scheduleMessage('3201111111', 'Test PHP', 'dd/MM/yyyy hh:mm');

Schedule SMS with a campaign name

//Return string
$scheduleId  = $elibom->scheduleMessage('3201111111', 'Test PHP', 'dd/MM/yyyy hh:mm', 'Campaign name');

List Scheduled SMS Messages

//Return json array
$scheduledMessages = $elibom->getScheduledMessages();

Show Scheduled SMS Message

//Return json object
$schedule = $elibom->getScheduledMessage('<schedule_id>');

Cancel Scheduled SMS Message

//Void
$elibom->unscheduleMessage('<schedule_id>');

List Users

//Return json array
$users = $elibom->getUsers();
foreach($users as $user) {
        echo json_encode($user);
}

Show User

//Return json object
$user = $elibom->getUser('<user_id>');

Show Account

//Return json object
$account = $elibom->getAccount();