README

This package is for Laravel Framework making super easy for developers to integrate the Sparrow SMS into Laravel Application and use instantly. For more details read Official Sparrow SMS Documentation.

Installation

Install this Package – Using Composer.

Composer Installation

composer require zerkxubas/sparrow-sms-laravel

Sail Installation

sail composer require zerkxubas/sparrow-sms-laravel

Publishing The Configurations

php artisan vendor:publish --tag=sparrow-sms

This will publish sparrow-sms.php inside the config directory of your laravel project.

.env Settings

inside the .env file use these below config values for quick setup.

SPARROW_SMS_ACCESS_TOKEN=
SPARROW_SMS_FROM=
SPARROW_SMS_BASE_URL=https://api.sparrowsms.com/v2/
SPARROW_SMS_DEBUG_MODE=true

NOTE: By default for demo accounts the Identity(FROM) is Demo.

Quick Examples

Send OTP Message

In this method i have made it super simpler & easier to implement & use instantly in laravel projects.

// use the namespace
use Zerkxubas\SparrowSmsLaravel\Facades\SparrowSms;
 
$response = SparrowSms::send($receiver, $message);

Get Credit Balance Information

This method helps to retrieve credit balance information from sparrow sms server.

// use the namespace
use Zerkxubas\SparrowSmsLaravel\Facades\SparrowSms;

$response = SparrowSms::getCreditBalance();

/*
* Usages
*/

// $response->credits_available
// $response->credits_consumed;
// $response->last_balance_added;
// $response->minimum_credit;
// $response->response_code;

Response

{
  "credits_available": 10,
  "credits_consumed": 1,
  "last_balance_added": 10,
  "minimum_credit": 1000,
  "response_code": 200
}

Verify Credit Balance

This helps to check whether there is sufficient credit available or not. returns bool

// use the namespace
use Zerkxubas\SparrowSmsLaravel\Facades\SparrowSms;

$creditStatus = SparrowSms::hasCreditBalance();

if ($creditStatus) {
    // Send the OTP or SMS.
}

License

This package is open-sourced & free to use licensed under the MIT license.

Additional

Reading Sparrow SMS official documentation is highly recommended as there might be new changes in future so it's crucial for a developer to be updated with the latest changes.

Author

Subash Sharma

zerkxubas / sparrow-sms-laravel

Maintainers

Details