https://github.com/laravel-notification-channels/all-my-sms
AllMySms notification channel for Laravel
https://github.com/laravel-notification-channels/all-my-sms
Last synced: 5 days ago
JSON representation
AllMySms notification channel for Laravel
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/all-my-sms
- Owner: laravel-notification-channels
- License: mit
- Created: 2019-10-30T00:57:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T15:23:14.000Z (about 1 year ago)
- Last Synced: 2025-06-12T01:07:41.292Z (10 days ago)
- Language: PHP
- Homepage: https://laravel-notification-channels.com
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# AllMySms notifications channel for Laravel
[](https://packagist.org/packages/laravel-notification-channels/all-my-sms)
[](LICENSE.md)
[](https://travis-ci.org/laravel-notification-channels/all-my-sms)
[](https://styleci.io/repos/217854455)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/all-my-sms)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/all-my-sms/?branch=master)
[](https://packagist.org/packages/laravel-notification-channels/all-my-sms)
This package makes it easy to send notifications using [AllMySms](https://www.allmysms.com/) with Laravel 5.5+, 6.x and 7.x.
## Contents
- [Installation](#installation)
- [Setting up the AllMySms service](#setting-up-the-AllMySms-service)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
``` bash
composer require laravel-notification-channels/all-my-sms
```
### Setting up the AllMySms service
Add the following code to you `config/services.php`:
```php
// config/services.php
...
'all_my_sms' => [
'uri' => env('ALL_MY_SMS_URI', 'https://api.allmysms.com/http/9.0'),
'login' => env('ALL_MY_SMS_LOGIN'),
'api_key' => env('ALL_MY_SMS_API_KEY'),
'format' => env('ALL_MY_SMS_FORMAT', 'json'),
'sender' => env('ALL_MY_SMS_SENDER'),
'universal_to' => env('ALL_MY_SMS_UNIVERSAL_TO'),
],
...
```
## Usage
Now you can use the channel in your `via()` method inside the notification:
``` php
use NotificationChannels\AllMySms\AllMySmsChannel;
use NotificationChannels\AllMySms\AllMySmsMessage;
use Illuminate\Notifications\Notification;
class ProjectCreated extends Notification
{
public function via($notifiable)
{
return [AllMySmsChannel::class]; // or 'all_my_sms'
}
public function toAllMySms($notifiable)
{
return new AllMySmsMessage('Content');
}
}
```
In order to let your Notification know which phone number to use, add the `routeNotificationForAllMySms` method to your Notifiable model.
This method needs to return a phone number.
```php
public function routeNotificationForAllMySms(Notification $notification)
{
return $this->phone_number;
}
```
### Local development
When developing an application that sends sms, you probably don't want to actually send sms to live phone numbers. You may set a universal recipient of all sms sent. This can be done by the `ALL_MY_SMS_UNIVERSAL_TO` environment variable or the `universal_to` option.
### Available Message methods
- `content(string $content)`: Accepts a string value for the sms content.
- `sender(string $sender)`: Accepts a string value for the sender name.
- `campaign(string $campaign)`: Accepts a string value for the sms campaign name.
- `sendAt(\DateTimeInterface|string $sendAt)`: Accepts a DateTimeInterface or string for the sms due date.
- `parameters(array $parameters)`: Accepts an array for the sms parameters.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## 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
- [Mikaël Popowicz](https://github.com/mikaelpopowicz)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.