vikilaboy/laravel-bird-notifications

Bird notification channel for Laravel 11.x

dev-master 2025-01-16 19:48 UTC

Requires

• php: ^8.0|^8.1|^8.2|^8.3|^8.4
• ext-json: *
• illuminate/notifications: ^9.0|^10.0|^11.0
• illuminate/queue: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0

Requires (Dev)

• mockery/mockery: ^1.4.4
• phpunit/phpunit: ^9.5.10|^10.0

MIT

• Victor Niculae

README

This package makes it easy to send Bird SMS notifications with Laravel.

Contents

• Requirements
• Installation
• Setting up your Bird account
• Usage
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Requirements

• Sign up for a free Bird account
• Create a new access_key in the developers sections

Installation

You can install the package via composer:

composer require vikilaboy/laravel-bird-notifications

for Laravel 5.4 or lower, you must add the service provider to your config:

// config/app.php
'providers' => [
    ...
    NotificationChannels\Bird\BirdServiceProvider::class,
],

Setting up your Bird account

Add the environment variables to your config/services.php:

// config/services.php
...
    'bird' => [
        'access_key' => env('BIRD_ACCESS_KEY'),
        'originator' => env('BIRD_ORIGINATOR'),
        'workspace' => env('BIRD_WORKSPACE'),
        'channel' => env('BIRD_CHANNEL'),
    ],
...

Add your Bird Access Key, Default originator (name or number of sender), and default recipients to your .env:

// .env
...
BIRD_ACCESS_KEY=
BIRD_ORIGINATOR=
BIRD_WORKSPACE=
BIRD_CHANNEL=
...

Notice: The originator can contain a maximum of 11 alfa-numeric characters.

Usage

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

use NotificationChannels\Bird\BirdChannel;
use NotificationChannels\Bird\BirdMessage;
use Illuminate\Notifications\Notification;

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

    public function toMessagebird($notifiable)
    {
        return (new BirdMessage("Your {$notifiable->service} was ordered!"));
    }
}

Additionally you can add recipients (single value or array)

return (new BirdMessage("Your {$notifiable->service} was ordered!"))->setRecipients($recipients);

In order to handle a status report you can also set a reference

return (new BirdMessage("Your {$notifiable->service} was ordered!"))->setReference($id);

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Credits

• Victor Niculae
• Peter Steenbergen
• Tonko Mulder
• All Contributors

License

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