Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ossycodes/nigeriabulksms
this package makes it easy to send notifications via Nigeriabulksms with Laravel
https://github.com/ossycodes/nigeriabulksms
Last synced: about 2 months ago
JSON representation
this package makes it easy to send notifications via Nigeriabulksms with Laravel
- Host: GitHub
- URL: https://github.com/ossycodes/nigeriabulksms
- Owner: ossycodes
- License: mit
- Created: 2020-08-14T17:20:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-22T13:38:15.000Z (over 1 year ago)
- Last Synced: 2024-04-24T15:10:14.001Z (8 months ago)
- Language: PHP
- Size: 33.2 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Nigeriabulksms notification channel for Laravel
[](https://packagist.org/packages/ossycodes/nigeriabulksms)
[](https://packagist.org/packages/ossycodes/nigeriabulksms)
This package makes it easy to send notifications using [Nigeriabulksms]('http://portal.nigeriabulksms.com/) with Laravel 5 and above
## Contents
- [About](#about)
- [Installation](#installation)
- [Setting up the Nigeriabulksms service](#setting-up-the-nigeriabulksms-service)
- [Usage](#usage)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## About
This package makes it possible to send out Laravel notifications as a `SMS ` using Nigeriabulksms API.
## Installation
You can install this package via composer:
``` bash
composer require ossycodes/nigeriabulksms
```
The service provider gets loaded automatically.
### Setting up the Nigeriabulksms service
You will need to [Register](https://nigeriabulksms.com) to get your `username and password`. Place them inside your `.env` file. Remember to add your Sender ID that you will be using to send the messages.
```bash
NIGERIABULKSMS_USERNAME=""
NIGERIABULKSMS_PASSWORD=""
NIGERIABULKSMS_SENDER=""
```
To load them, add this to your `config/services.php` . This will load the Nigeriabulksms data from the `.env` file.file:
```php
'nigeriabulksms' => [
'username' => env('NIGERIABULKSMS_USERNAME'),
'password' => env('NIGERIABULKSMS_PASSWORD'),
'sender' => env('NIGERIABULKSMS_SENDER'),
]
```
Add the `routeNotifcationForNigeriabulksms` method on your notifiable Model.
```php
phone;
}
}
```
## Usage
To use this package, you need to create a notification class, like `NewsWasPublished` from the example below, in your Laravel application. Make sure to check out [Laravel's documentation](https://laravel.com/docs/master/notifications) for this process.
```php
setContent('Your SMS message content');
}
}
```
Additionally you can add recipients(the phonenumber the messages will be sent to) (single value or array)
``` php
return (new NigeriabulksmsMessage("Your {$notifiable->service} was ordered!"))->setRecipients($recipients);
```
also you can add who the notification(sms) is sent from, this will overide the
NIGERIABULKSMS_SENDER="" in your .env
``` php
return (new NigeriabulksmsMessage("Your {$notifiable->service} was ordered!"))->setFrom("name of your app");
```
Incase of errors from Nigeriabulksms service please do well to check [Nigeriabulksms api error codes on thier developer portal](https://nigeriabulksms.com/sms-gateway-api/)
## Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Osaigbovo Emmanuel](https://github.com/ossycodes)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## How do I say Thank you?
Leave a star and follow me on [Twitter](https://twitter.com/ossycodes) .