Baspa / spryng

📲 Spryng Notifications Channel for Laravel

Spryng Notification Channel

📲 Spryng Notifications Channel for Laravel

Contents

• Installation
  • Setting up the Spryng service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

composer require laravel-notification-channels/spryng

Add the configuration to your services.php config file:

'spryng' => [
    'key' => env('SPRYNG_API_KEY'),
]

Setting up the Spryng service

You'll need a Spryng account. Head over to their website and create or login to your account.

Head to your Profile and then Security in the sidebar to generate a set of API keys.

Usage

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

use Illuminate\Notifications\Notification;
use \NotificationChannels\Spryng\SpryngMessage;
use \NotificationChannels\Spryng\SpryngChannel;

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

    public function toSpryng($notifiable)
    {
        return (new SpryngMessage)
			->setBody("Task #{$notifiable->id} is complete!")
			->setRecipients($notifiable->phone_number)
			->setOriginator(config('app.name'));
    }
}

Make sure your Notifiable model has a phone_number attribute, which will be used to send the SMS. Also make sure it's a valid phone number.

Available Message methods

• setBody(''): Accepts a string value for the message body.
• setRecipients(''): Accepts a string or array value for the recipient(s) phone number.
• setOriginator(''): Accepts a string value for the sender name.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Bas van Dinther
• Spryng
• All Contributors

License

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