README

Laravel Package to send sms using websms.lk SMS Gateway

This package allows you to send sms to multiple numbers at once using websms.lk API

Table of Contents

1. Installation
2. Publish the config file
3. .env config
4. Usage
5. Contributing
6. Author
7. License

Installation

composer require dinushchathurya/websmslk

Publish the config file

php artisan vendor:publish --provider="Dinushchathurya\Websms\SmsServiceProvider"

Add the following to your .env file

SMS_API_KEY=<your-api-key>
SMS_API_TOKEN=<your-api-token>
SMS_SENDER_ID=<your-sender-id>
SMS_TYPE= sms
SMS_ROUTE=0

For more information about the above parameters, please visit websms.lk

Usage

This is a simple example of how to send SMS using this package.

use Dinushchathurya\Websms\Sms;

public function sendSms()
{
  try {
    $numbers      = ['9476xxxxxx','9471xxxxxxx'];
    $message      = "ආයුබෝවන්. සාදරයෙන් පිළිගනිමු";
    $scheduledate = Carbon::now()->toDateTimeString();
    Sms::send($numbers, $message, $scheduledate);                     
    return response()->json([
      'message' => 'SMS sent successfully'
    ]);  
  } catch (\Exception $e) {
      return response()->json([
        'message' => 'An error occurred while sending SMS: ' . $e->getMessage()
      ], 500);
  }
}

Route::get('/send-sms', [App\Http\Controllers\SmsController::class, 'sendSms'])->name('send-sms');

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Author

Author Dinush Chathurya

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2023 Dinush Chathurya, Open Source SriLanka and codingtricks.io