guiigaspar/laravel-zenvia-channel

Provides Zenvia notification channel for Laravel

1.0.3 2024-04-16 15:03 UTC

Requires

• php: >=7.2|^8.0
• guzzlehttp/guzzle: ^7.0
• illuminate/notifications: ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
• illuminate/support: ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0

Requires (Dev)

• mockery/mockery: ^1.3
• orchestra/testbench: ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0
• phpunit/phpunit: ^8.5|^9.5|^10.5

MIT

• Guilherme Gaspar

• sms
• notification
• laravel
• zenvia

README

This package makes it easy to send notifications using Zenvia with Laravel 7.x, 8.x, 9.x, 10.x, 11.x

Contents

• Installation
  • Configuration
  • Advanced Configuration
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require guiigaspar/laravel-zenvia-channel

Configuration

Add your Zenvia Account, Password, and From Name (optional) to your .env:

ZENVIA_ACCOUNT=XYZ
ZENVIA_PASSWORD=XYZ
ZENVIA_FROM=XYZ # optional

Advanced Configuration

Run php artisan vendor:publish --provider="NotificationChannels\LaravelZenviaChannel\ZenviaServiceProvider"

/config/zenvia-notification-channel.php

Usage

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

use NotificationChannels\LaravelZenviaChannel\ZenviaChannel;
use NotificationChannels\LaravelZenviaChannel\ZenviaSmsMessage;
use Illuminate\Notifications\Notification;

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

    public function toZenvia($notifiable)
    {
        return (new ZenviaSmsMessage())
            ->content("Your order {$notifiable->orderId} was approved!");
    }
}

In order to let your Notification know which phone are you sending/calling to, the channel will look for the phone_number attribute of the Notifiable model. If you want to override this behaviour, add the routeNotificationForZenvia method to your Notifiable model.

public function routeNotificationForZenvia()
{
    return '[phone]';
}

Available Message methods

ZenviaSmsMessage

• id(''): Accepts a ID to use as the notification identifier.
• content(''): Accepts a string value for the notification body.
• schedule(''): Accepts a string value for the notification schedule.

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

• Guilherme Gaspar
• All Contributors

License

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