grupodkt/notification-channel-waba

Notification channel WABA.

v5.8.3 2024-07-18 17:28 UTC

Requires

• php: >=7.0.0
• guzzlehttp/guzzle: ^6|^7
• illuminate/events: ^7|^8|^9
• illuminate/notifications: ^7|^8|^9
• illuminate/queue: ^7|^8|^9
• illuminate/support: ^7|^8|^9

Requires (Dev)

• mockery/mockery: ^0.9.5
• phpunit/phpunit: 4.*

MIT

• Luis Echeverria

README

This package makes it easy to send [Waba notifications] with Laravel 5.4.

Installation

Contents

• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require grupodkt/notification-channel-waba

You must install the service provider:

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

Setting up your Waba account

Add your Waba Account SID, Auth Token, and phoneNumberId to your config/services.php:

// config/services.php
...
'waba' => [
    'url'   => env('WABA_URL'),
    'token' => env('WABA_TOKEN'),
    'phoneNumberId' => env('WABA_PHONE_NUMBER_ID'),
],
...

Usage

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

use NotificationChannels\Waba\WabaChannel;
use NotificationChannels\Waba\WabaMessage;
use Illuminate\Notifications\Notification;

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

    public function toWaba($notifiable)
    {
        return (new WabaMessage())
            ->content("Your {$notifiable->service} account was approved!");
    }
}

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

public function routeNotificationForWaba()
{
    return $this->mobile;
}

Available Message methods

WabaSmsMessage

• from(''): Accepts a phone to use as the notification sender.
• content(''): Accepts a string value for the notification body.

Changelog

Please see CHANGELOG for more information what has changed recently.

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

• GRUPODKT

License

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