mildlettuce/blender-php-api

Blender Bulk SMS Platform - Send SMS via PHP

blender-api-php

Blender Bulk SMS Platform - Send SMS via PHP, _(*1)

Send SMS to single recipient

require_once("bulksms/BulkSMS.php");
# Create client instance
$bulksms = new Blender\Client\BulkSMS();
# Login to gateway
$bulksms->login($USERNAME, $PASSWORD);
# Send to a single recipient
$response = $bulksms->singleRecipient("originator", "61400000000", "Test SMS", $ROUTE_ID, "my-reference");

see demo/Demo.php, _(*2)

Get Route ID by Recipient/MSISDN

require_once("bulksms/BulkSMS.php");
require_once("bulksms/AutoRoute.php");
# Create client instance
$bulksms = new Blender\Client\BulkSMS();
# Login to gateway
$bulksms->login($USERNAME, $PASSWORD);
# Initialize Autoroute
$autoRoute = new AutoRoute($bulksms);
# Get Route ID
$ROUTE_ID = $autoRoute->getRouteId($recipient);

see demo/AutoRouting.php, _(*3)

Get Route ID by Country

require_once("bulksms/BulkSMS.php");
# Create client instance
$bulksms = new Blender\Client\BulkSMS();
# Login to gateway
$bulksms->login($USERNAME, $PASSWORD);
# Get route id
$ROUTE_ID = $bulksms->getRouteIdByCountry("Australia");

see demo/Routing.php, _(*4)

Send same message to multiple recipients

require_once("bulksms/BulkSMS.php");
# Create client instance
$bulksms = new Blender\Client\BulkSMS();
# Login to gateway
$bulksms->login($USERNAME, $PASSWORD);
# Create batch
$batch = new Blender\Client\BatchMessageSingleBody();
# Set originator
$batch->setOriginator("test");
# Set route id
$batch->setRouteId($ROUTE_ID);
# Set message body (for all recipients)
$batch->setBody("Batch unicode message with 漢語");

## Recipients ##
$batch->addMSISDN("61000000001");
$batch->addMSISDN("61000000002");
$batch->addMSISDN("61000000003");

# Send message
$responseXml = $bulksms->sendBatch($batch);

see demo/Demo.php, _(*5)

Send multiple messages to multiple recipients

require_once("bulksms/BulkSMS.php");
# Create client instance
$bulksms = new Blender\Client\BulkSMS();
# Login to gateway
$bulksms->login($USERNAME, $PASSWORD);
# Create batch
$batch = new Blender\Client\BatchMessageMultiBody();
# Set default originator (you can override per recipient)
$batch->setOriginator("test");
# Set default route id (you can override per recipient)
$batch->setRouteId($ROUTE_ID);
# Set default message body (you can override per recipient)
$batch->setBody("Batch unicode message with 漢語");

## Recipients ##
# Add recipient
$batch->addRecipient1($recipient);
# Add recipient, override message
$batch->addRecipient2($recipient, "different message");
# Add recipient with unicode message
$batch->addRecipient2($recipient, "different message with unicode טוקיו 東京(Tokyo)");
# Add new message with different originator, recipient and long body
$longtext = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse auctor turpis at nunc rutrum, eget sodales turpis molestie. Nullam mattis sit amet urna et tristique. Vivamus nec justo et dui sed. 200+ chars";
$batch->addRecipient("orignew", $recipient, $longtext);

# Send message
$responseXml = $bulksms->sendBatch($batch);

see demo/Demo.php, _(*6)

Schedule message

require_once("bulksms/BulkSMS.php");
$bulksms = new Blender\Client\BulkSMS();
$bulksms->login($USERNAME, $PASSWORD);
$batch = new Blender\Client\BatchMessageMultiBody();

# Schedule message with date/time/timezone
// https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
$batch->setSchedule("2017-01-01T15:24:04", "Australia/Melbourne");

see demo/Demo.php, and list of timezones, _(*7)

Shorten URL

# Set originator
$batch->setOriginator("test");
## Recipients ##
$batch->addMSISDN("61000000001");
# Set route id
$batch->setRouteId($ROUTE_ID);
# Set message body (for all recipients)
$batch->setBody("Batch with URL: http://www.mydomain.com/specialoffer");

// -------[ SHORT URL ]--------
$batch->setShortUrl(true);
// ----------------------------

# Send message
$responseXml = $bulksms->sendBatch($batch);

see demo/Demo.php, _(*8)

Receive SMS

require_once(dirname(__FILE__) . "/bulksms/DeliveryMessage.php");
$xml = $_POST['xml'];
$incomingMessage = new Blender\Client\DeliveryMessage($xml);
$originator = $incomingMessage->getOriginator();
$body = $incomingMessage->getBody();

see demo/MOHandler.php, _(*9)

Receive Receipt

require_once(dirname(__FILE__) . "/bulksms/DeliveryReceipt.php");
$xml = $_POST['xml'];
$receipt = new Blender\Client\DeliveryReceipt($xml);
$myref = $receipt->getClientReference();
$status = $receipt->getStatus();

see demo/DRHandler.php, _(*10)

Check Balance

require_once("bulksms/BulkSMS.php");
# Create client instance
$bulksms = new Blender\Client\BulkSMS();
# Login to gateway
$bulksms->login($USERNAME, $PASSWORD);
# Get Balance
$balance = $bulksms->getBalance();

see demo/BalanceAlert.php, _(*11)