README

This package makes it easy to send notifications using https://green-api.com/en/ with Laravel 11+.

Code Reference from laravel-notification-channels/smsc-ru

Contents

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

Installation

You can install the package via composer:

composer require shiroamada/green-api-laravel-notification

Then you must install the service provider:

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

Setting up the Green API service

Add your green api instanceId and token to your config/services.php:

// config/services.php
...
'green_api' => [
    'isEnable' => env('GREEN_API_ENABLE') ?? 0,
    'apiUrl' => env('GREEN_API_URL') ?? 'https://1103.api.green-api.com/',
    'instanceId' => env('GREEN_API_INSTANCEID'),
    'token' => env('GREEN_API_TOKEN'),
    'isMalaysiaMode' => env('GREEN_API_MALAYSIA_MODE') ?? 0,
    'isDebug' => env('GREEN_API_DEBUG_ENABLE') ?? 0,
    'debugReceiveNumber' => env('GREEN_API_DEBUG_RECEIVE_NUMBER'),
],
...

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\GreenApi\GreenApiMessage;
use NotificationChannels\GreenApi\GreenApiChannel;

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

    public function toGreenApi($notifiable)
    {
        return GreenApiMessage::create("Task #{$notifiable->id} is complete!");
    }
}

In your notifiable model, make sure to include a routeNotificationForGreenApi() method, which return the phone number.

public function routeNotificationForGreenApi()
{
    return $this->mobile; //depend what is your db field
}

// routes/web.php
$this->get('preview-notification', function () {

    $user = User::where('email', 'shiroamada@shiro.my')->first();
     Notification::route('greenapi', $user->mobile)->notify(
         new \App\Notifications\SendTest()
     );

Available methods

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

To send a next new line message, in PHP please use double quote "\n"

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please use the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• ShiroAmada
• All Contributors

License

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