itsaafrin/isms

A Laravel 4 SMS Api Package (isms.com.my)

dev-master 2014-09-03 10:10 UTC

Requires

• php: >=5.4.0
• illuminate/support: 4.3.*

MIT

• Aafrin

• api
• sms
• laravel

README

Introduction
This is Laravel 4 Package that can be used to integrate Malaysian SMS gateway to your project. The following package is utilizing the SMS gateway service provided by ISMS (isms.com.my)

Installation
In the require key of composer.json file add the following

"itsaafrin/isms": "dev-master"

Next run the composer update command to fetch and update the package into your project

composer update

In your config/app.php add 'Itsaafrin\Isms\IsmsServiceProvider' to the end of the $providers array

'providers' => array(

    'Illuminate\Foundation\Providers\ArtisanServiceProvider',
    'Illuminate\Auth\AuthServiceProvider',
    ...
    'Itsaafrin\Isms\IsmsServiceProvider',

),

At the end of config/app.php add 'ISMS' => 'Itsaafrin\Isms\IsmsFacade' to the $aliases array

'aliases' => array(

    'App'        => 'Illuminate\Support\Facades\App',
    'Artisan'    => 'Illuminate\Support\Facades\Artisan',
    ...
    'ISMS' => 'Itsaafrin\Isms\IsmsFacade',

),

Navigate to vendor/itsaafrin/isms/src/config/config.php and add your username and password of the isms.com.my account

'username' => 'your_username',
'password' => 'your_password',

Usage
To send sms:

ISMS::SendSMS("destination no", "message to be sent", "sms type");

• The first parameter (destination_no) : The number where the message should be sent.
• The second parameter (message to be sent) : The content of the message.
• The third parameter (sms type) : 1 for ASCII and 2 for UNICODE

To check balance:

ISMS::CheckBalance();

Both the function above will return http result and http code as an array. For sending message, empty response for http result indicates message sent successfully.

Example
Sending message:

public function SendTestMsg(){
$result = ISMS::SendSMS("0123456789", "Hello World", "2");
dd($result);
}

Checking Balance:

public function CheckTestBalance(){
$result = ISMS::CheckBalance();
dd($result);
}

Bugs & Errors
Raise any bugs or erros here.

Note: This is just an initial release and more functionality will be added as the time goes. Feel free to raise any feature request or suggestion. More info -- http://www.laravelmy.com/2014/04/05/malaysian-sms-gateway-api-laravel-4-package/