klobes/laravel-routee-channel

Notification channel for routee.net

dev-master 2024-08-23 23:22 UTC

Requires

• php: >=7.1.0

Requires (Dev)

• guzzlehttp/guzzle: ^6.3 || ^7.0
• mockery/mockery: ^0.9.5
• phpunit/phpunit: >=7.0 < 10

MIT

• Klodjan bracja

README

This package makes it easy to send SMS notifications using routee.net with Laravel 10.0+.

Warning!

Only Routee SMS is implemented at the moment, if you want more channels feel free to write them yourself in RouteeApi or point me to an API wrapper that we can switch to.

Contents

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

Installation

Install this package with Composer:

composer require klobes/laravel-routee-channel:dev-master

### Setting up the Routee service

Add your Routee application id, application secret and sender id (from) to your `config/services.php`:

```php
// config/services.php
'routee' => [
    'app_id'  => env('ROUTEE_APP_ID'),
    'secret' => env('ROUTEE_SECRET'),
    'from' => env('ROUTEE_SENDER_ID'),
],

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\Routee\RouteeMessage;
use NotificationChannels\Routee\RouteeChannel;

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

    public function toRoutee($notifiable)
    {
        return (new RouteeMessage)
            ->content("Your message here");
    }
}

In your notifiable model, make sure to include a routeNotificationForRoutee() method, which returns a phone number or an array of phone numbers.

public function routeNotificationForRoutee()
{
    return $this->phone;
}

Available methods

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

sendAt(): Set a time for scheduling the notification message.

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

• anheric
• All Contributors

License

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