Skip to content

Latest commit

 

History

History
114 lines (87 loc) · 2.91 KB

README.md

File metadata and controls

114 lines (87 loc) · 2.91 KB

Laravel HTTP SMS Sender

image Latest Stable Version License

Easy HTTP (GET/POST) SMS Package for Indian SMS Service Providers.

Features

  • Easy to use and customize api
  • Supports almost all http sms service providers
  • A simple configuration in single file
  • Use dynamic parameters at runtime
  • Config query parameters and post fields in config file

Installation

Use composer to install package in your laravel project

Type in terminal

composer require durranilab/httpsms

Publish a config file

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

This will generate a config file at config/smsconfig.php

Configuration Open config/smsconfig.php

  • Insert your url from SMS Provider
  • Insert your url Parameters as requires (you can insert any number of parameters for your request)

Sample config file:

<?php
return [
    // HTTP METHOD (get/post)
    'method' => 'get',
    //SMS URL (FOR SENDING SMS)
    'sms_url' => 'http://www.alots.in/sms-panel/api/http/index.php',
    'sms_params' => [
        'username' => 'API_USER_NAME',
        'apikey' => 'API_KEY_OR_PASSWORD',
        'CUSTOM_FIELD_3' => 'ANY_INFO',
    ],
    //BALANCE CHECK URL (FOR SENDING SMS)
    'balance_url' => 'http://www.alots.in/sms-panel/api/http/index.php',
    'balance_params' => [
        'username' => 'API_USER_NAME',
        'apikey' => 'API_KEY_OR_PASSWORD',
        'ANY_QUERY' => 'ANY_QUERY',
        'route' => 'TRANS',
        'format' => 'JSON,TEXT',
    ],

];

Usage

  • Using Facades
use Durranilab\Httpsms\Facades\HttpSMS; 

...

// WHEN ALL PARAMETERS ARE SET IN CONFIG FILE USE
$balanceResponse = HttpSMS::getBalance();
// OR TO USE PARAMETERS IN METHOD
$balanceResponse = HttpSMS::getBalance(
                    ['username'=>'durranilab',
                    'password'=>'YOURPASSWORD',
                    ]);

//TO SEND SMS
$phone = "9764000000,9764123456,...";
$msg = "SMS \n TEXT ";

// WHEN ALL PARAMETERS ARE SET IN CONFIG FILE USE
$smsResponse = HttpSMS::sendMessage();
// OR TO USE PARAMETERS IN METHOD
$smsResponse = HttpSMS::sendMessage([
                   'TemplateID' => '1234567890',
                   'message' => $msg,
                   'mobile' => $phone]);
  • Using Class Methods
use Durranilab\Httpsms\HttpSMS;
...

$smsProvider = new HttpSMS();

$balanceResponse = $smsProvider->getBalance();
$smsResponse = $smsProvider->sendMessage();
//OR
$balanceResponse = $smsProvider->getBalance(['username'=>'user123']);
$smsResponse = $smsProvider->sendMessage(['username'=>'user123']);

For any issue feel free to raise an issue on github repo.

Thank You!