Laravel PHP SMS API Integration: Abstraction to send SMS messages via multiple APIs

Recommend this page to a friend!
  Info   Documentation   View files (29)   Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2019-11-30 (8 months ago) Not yet rated by the usersTotal: 45 This week: 1All time: 9,859 This week: 242
Version License PHP version Categories
laravel-sms 1.0.0Custom (specified...5PHP 5, Wireless and Mobile, Web services
Description Author

This package provides an abstraction to send SMS messages via multiple APIs.

It provides an abstract class that offers a fluent interface to perform common steps for sending a SMS message like setting the message text, sender and recipient numbers.

Then there are concrete classes that extende the abstract base class to provide implementations by accessing the APIs of different providers. Currently the package provides implementation classes for:

- AfricasTalking
- BetaSms
- BulkSmsNigeria
- GoldSms247
- InfoBip
- KudiSms
- MeboSms
- MultiTexter
- Nexmo
- NigerianBulkSms
- RingCaptcha
- SmartSmsSolutions
- SmsLive247
- XWirelesS

Picture of Zacchaeus Bolaji
  Performance   Level  
Name: Zacchaeus Bolaji <contact>
Classes: 13 packages by
Country: Nigeria Nigeria
Age: ???
All time rank: 302016 in Nigeria Nigeria
Week rank: 246 8 in Nigeria Nigeria
Innovation award
Innovation award
Nominee: 8x

Details

Laravel SMS

CircleCI Latest Stable Version Total Downloads License StyleCI Build Status Scrutinizer Code Quality Code Coverage

Laravel SMS allows you to send SMS from your Laravel application using one of over 10 sms providers, or your own sms provider.

Installation

Step 1

You can install the package via composer:

composer require djunehor/laravel-sms

Laravel 5.5 and above

The package will automatically register itself, so you can start using it immediately.

Laravel 5.4 and older

In Laravel version 5.4 and older, you have to add the service provider in config/app.php file manually:

'providers' => [
    // ...
    Djunehor\Sms\SmsServiceProvider::class,
];

Lumen

After installing the package, you will have to register it in bootstrap/app.php file manually:

// Register Service Providers
    // ...
    $app->register(Djunehor\Sms\SmsServiceProvider::class);
];

Env Keys

SMS_SENDER=

BETASMS_USERNAME=
BETASMS_PASSWORD=

BULK_SMS_NIGERIA_TOKEN=
BULK_SMS_NIGERIA_DND=

GOLD_SMS_247_USERNAME=
GOLD_SMS_247_PASSWORD=

MULTITEXTER_USERNAME=
MULTITEXTER_PASSWORD=

SMART_SMS_TOKEN=

XWIRELESS_API_KEY=
XWIRELESS_CLIENT_ID=

NEXMO_API_KEY=
NEXMO_API_SECRET=

RING_CAPTCHA_APP_KEY=
RING_CAPTCHA_API_KEY=
RING_CAPTCHA_APP_SECRET=

AFRICASTALKING_API_KEY=
AFRICASTALKING_USERNAME=

NIGERIAN_BULK_SMS_USERNAME=
NIGERIAN_BULK_SMS_PASSWORD=

KUDI_SMS_USERNAME=
KUDI_SMS_PASSWORD=

MEBO_SMS_API_KEY=

SMSLIVE247_TOKEN=

INFOBIP_BASE_URL=
INFOBIP_USERNAME=
INFOBIP_PASSWORD=

Step 2 - Publishing files

Run: php artisan vendor:publish --tag=laravel-sms This will move the migration file, seeder file and config file to your app. You can set your sms details in the config file or via env

Step 3 - Adding SMS credentials

  • Add the env keys to your `.env` file
  • Or edit the config/laravel-sms.php file

Usage

//using betaSMS
use Djunehor\Sms\BetaSms;`

$sms = new BetaSms();
$sms->text($message)->to(08135087966)->from('MyLaravel')->send();

Using Helper function

//MeboSms
$send = send_sms($message, $to, $from, MeboSms::class);

The default SMS provider is Nexmo. You can set the default SMS provider in config/laravel-sms.php e.g 'default' => \Djunehor\Sms\Concrete\SmartSmsSolutions::class,, so you can use the helper function like this:

$send = send_sms($message, $to);
//$from is optional and is better set in the config

Available SMS Providers

|Provider|URL|Tested| |:--------- | :-----------------: | :------: | |Nexmo|https://developer.nexmo.com/api/sms#send-an-sms|Yes| |AfricasTalking|https://build.at-labs.io/docs/sms%2Fsending|Yes|| |BetaSms|https://login.betasms.com.ng/|Yes| |MultiTexter|https://web.multitexter.com/MultiTexter_HTTP_SMS_API%202.0.pdf|Yes| |BulkSmsNigeria|https://www.bulksmsnigeria.com/bulk-sms-api|Yes| |GoldSms247|https://goldsms247.com/index.php/api|Yes| |KudiSms|https://kudisms.net/api/|Yes| |Mebosms|http://mebosms.com/api-sms|Yes| |NigerianBulkSms|https://nigeriabulksms.com/sms-gateway-api/|Yes| |SmartSmsSolutions|https://docs.smartsmssolutions.com/docs/send-with-basic-route|Yes| |RingCaptcha|https://my.ringcaptcha.com/docs/api|No| |SmsLive247|http://portal.smslive247.com/developer_api/http.aspx|No| |XWireless|https://xwireless.net/cportal/knowledge-base/article/sms-3|No| |InfoBip|https://dev.infobip.com/send-sms/single-sms-message|No|

Creating custom SMS Provider

  • Create a class that extends `Djunehor\Sms\Concrete\Sms` class
  • Implement the `send()` which makes the request and return bool
  • (Optional) You can add the provider keys to the config/laravel-sms.php

Contributing

  • Fork this project
  • Clone to your repo
  • Make your changes and run tests `composer test`
  • Push and create Pull request
  Files  
File Role Description
.circleci (1 file)
src (1 file, 4 directories)
tests (3 files)
.scrutinizer.yml Data Auxiliary data
.styleci.yml Data Auxiliary data
composer.json Data Auxiliary data
LICENSE Lic. License text
phpunit.xml Data Auxiliary data
README.md Doc. Documentation

  Files  /  .circleci  
File Role Description
   config.yml Data Auxiliary data

  Files  /  src  
File Role Description
Concrete (15 files)
config (1 file)
Contract (1 file)
Helpers (1 file)
   SmsServiceProvider.php Class Class source

  Files  /  src  /  Concrete  
File Role Description
   AfricasTalking.php Class Class source
   BetaSms.php Class Class source
   BulkSmsNigeria.php Class Class source
   GoldSms247.php Class Class source
   InfoBip.php Class Class source
   KudiSms.php Class Class source
   MeboSms.php Class Class source
   MultiTexter.php Class Class source
   Nexmo.php Class Class source
   NigerianBulkSms.php Class Class source
   RingCaptcha.php Class Class source
   SmartSmsSolutions.php Class Class source
   Sms.php Class Class source
   SmsLive247.php Class Class source
   XWireless.php Class Class source

  Files  /  src  /  config  
File Role Description
   laravel-sms.php Class Class source

  Files  /  src  /  Contract  
File Role Description
   SmsServiceInterface.php Class Class source

  Files  /  src  /  Helpers  
File Role Description
   helpers.php Example Example script

  Files  /  tests  
File Role Description
   SmsHelperTest.php Class Class source
   SmsTest.php Class Class source
   TestCase.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:45
This week:1
All time:9,859
This week:242

For more information send a message to info at phpclasses dot org.