franckysolo/octopush-sdk

Php SDK for octopush API SMS

v1.0.3 2018-10-27 17:21 UTC

Requires

• php: ^7.1.3

Requires (Dev)

• phpunit/phpunit: ^7.1

MIT

• franckysolo

• php
• sms
• octopush

README

Php SDK for Octopush API SMS

Installation

composer require franckysolo/octopush-sdk

tests

Create a env.php file in tests/config

<?php

define('OCTOPUSH_API_KEY', 'your-key');
define('OCTOPUSH_LOGIN', 'your-login');
define('TEST_PHONE_NUMBER', 'your-phone-number');

?>

To run tests

composer test

Usages

Config

Create a app.php file in configs directory

<?php

define('OCTOPUSH_API_KEY', 'your-key');
define('OCTOPUSH_LOGIN', 'your-login');
define('TEST_PHONE_NUMBER', '0033601010101'); // for fr format
define('TEST_PHONE_NUMBER_ALT', '0033601010102');

?>

Get Credit

<?php

require_once '../vendor/autoload.php';
require_once '../configs/app.php';

use Octopush\Api;

$api = new Api(OCTOPUSH_LOGIN, OCTOPUSH_API_KEY);
$credit = $api->getCredit();
?>
<pre>
Remaining Credit :  <?php echo $credit;?> &euro;
</pre>

Get Balance

<?php
require_once '../vendor/autoload.php';
require_once '../configs/app.php';

use Octopush\Api;

$api = new Api(OCTOPUSH_LOGIN, OCTOPUSH_API_KEY);
$balance = $api->getBalance();
$premium = $api->getPremiumBalance();
$low = $api->getLowCostBalance();
?>
<pre>
  <?php var_dump(balance);?>

  Remaining Sms Low cost :  <?php echo $low;?>

  Remaining Sms Premium :  <?php echo $premium;?>
</pre>

Send a simple message

<?php
require_once '../vendor/autoload.php';
require_once '../configs/app.php';

use Octopush\Api;

$api = new Api(OCTOPUSH_LOGIN, OCTOPUSH_API_KEY);
$message = 'this is a simple sms message';
$api->sendMessage($message, [
  'sms_recipients' => TEST_PHONE_NUMBER,
  'sms_text' => $message,
  'sms_type' => Message::SMS_PREMIUM,
  'sms_sender' => 'Octopush sdk'
]);
?>
<pre>
<?php echo var_dump($api->getClient()->getResponse());?>
</pre>

Send a publipostage message

<?php
require_once '../vendor/autoload.php';
require_once '../configs/app.php';

use Octopush\Api;

$api = new Api(OCTOPUSH_LOGIN, OCTOPUSH_API_KEY);
$message = 'Hello {ch1} {nom} {prenom}, your session begin at {ch2} the {ch3}';

$api->sendMessage($message, [
  'sms_recipients' => [TEST_PHONE_NUMBER, TEST_PHONE_NUMBER_ALT],
  'sms_text' => $message,
  'sms_type' => Message::SMS_PREMIUM,
  'sms_sender' => 'Octopush sdk',
  'request_mode' => Message::SIMULATION_MODE,
  'recipients_first_names' => ['John', 'Jane'],
  'recipients_last_names' => ['John', 'Jane'],
  'sms_fields_1' => ['Mr', 'Miss'],
  'sms_fields_2' => ['08:00 am', '01:00 pm'],
  'sms_fields_3' => ['2018/05/21', '2018/05/22'],
]);