README

Package Moved

This package has moved to https://github.com/laravel-notification-channels/sms-broadcast

Please update you composer.json to the new location. The namespacing has not changed, so you can just swap the packages out.

## Old Readme

This package makes it easy to send notifications using Sms Broadcast with Laravel > 5.6.

It uses my Sms Broadcast PHP package under the hood.

Installation
- [Setting up the Sms Broadcast service](#setting-up-the-Sms Broadcast-service)
Usage
- Available Message methods
Changelog
Testing
Security
Contributing
Credits
License

Installation

Install the package using composer

composer require atymic/laravel-notification-channel-sms-broadcast

Add the configuration to your services.php config file:

'smsbroadcast' => [
    'username' => env('SMS_BROADCAST_USERNAME'),
    'password' => env('SMS_BROADCAST_PASSWORD'),
    'default_sender' => env('SMS_BROADCAST_DEFAULT_SENDER', null),
]

Usage

You can use the channel in your via() method inside the notification:

use Illuminate\Notifications\Notification;
use NotificationChannels\SmsBroadcast\SmsBroadcastMessage;
use NotificationChannels\SmsBroadcast\SmsBroadcastChannel;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [SmsBroadcastChannel::class];
    }

    public function toSmsbroadcast($notifiable)
    {
        return (new SmsBroadcastMessage)
            ->content("Task #{$notifiable->id} is complete!");
    }
}

In your notifiable model, make sure to include a routeNotificationForSmsbroadcast() method, which returns an australian phone number.

public function routeNotificationForSmsbroadcast()
{
    return $this->phone; // 0412345678 or 6142345678
}

Available methods

sender(): Sets the sender's name or phone number.

content(): Set a content of the notification message.

delay(): Set a delay, in minutes before sending the message

reference(): Set the SMS ref code

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

atymic / laravel-notification-channel-sms-broadcast

Maintainers

Details