Sms Owl PHP Wrapper
This package is wrapper of Sms Owl REST API hosted at https://smsowl.in. Sms Owl provides transactional and promotional SMS Gateway services., (*1)
Installing Sms Owl library
You can download library in two ways., (*2)
- Using composer.
- Download PHP file directly.
1. Using Composer
Install composer in your project. Skip this step if you already have composer., (*3)
curl -sS https://getcomposer.org/installer | php
a. Install the library using either following command, (*4)
php composer.phar require mahoujas/smsowl
b. Or by adding library to composer.json and running update command, (*5)
{
"require": {
"mahoujas/smsowl": "^1.0.0"
}
}
php composer.phar update
Autoload the classes. Skip this step if you already done it., (*6)
require 'vendor/autoload.php';
2. Download PHP library directly
Download PHP library directly from this link, (*7)
Include download file in your project., (*8)
include("/path-to-file/smsowl.php");
Use namespaces
After you have downloaded and included library using either of above method, use the following namespace to access the class., (*9)
use Mahoujas\SmsOwl\SmsOwl;
use Mahoujas\SmsOwl\SmsType;
Initialize the object
Credentials should be configured before sending SMS. Credential should be passed as constructor argument for SmsOwlClient constructor, (*10)
$smsOwl = new SmsOwl("YOUR-ACCOUNT-ID", "YOUR-API-KEY");
- senderId: Sender Id registered and approved in Sms Owl portal.
- to: Either single number with country code or array of phone numbers.
- message: Message to be sent.
-
smsType: It can have either of two values normal or flash (optional), (*11)
try{
$smsId = $smsOwl->sendPromotionalSms("TESTER", "+9189876543210", "Hello PHP", SmsType::FLASH);
//Process smsId if you need to
}
catch(Exception $e){
//Handle exception.
}
Return value is Sms Id for single SMS or array of SMS ids for Bulk Sms, (*12)
Same as above but smsType defaults to SmsType::NORMAL, (*13)
Sending Transactional SMS
sendTransactionalSms(senderId,to,templateId,placeholderArray);
- senderId: Sender Id registered and approved in Sms Owl portal.
- to: Destination number with country prefix. Only single number can be specified.
- templateId: Template Id of message. Only template message can be send via transactional route.
- placeholderArray: Placeholder values.
Lets assume templateId of 39ec9de0efa8a48cb6e60ee5 with following template., (*14)
Hello {customerName}, your invoice amount is Rs. {amount}.
-, (*15)
try{
$smsId = $smsOwl->sendTransactionalSms("TESTER", "+919876543210", "39ec9de0efa8a48cb6e60ee5",array('customerName' => 'Bob', 'amount' => '200' });
//Process smsid if needed.
}
}catch(Exception $e){
//Handle exception
}
Return value is Sms Id., (*16)
Wallogit.com
