csgt/notification-channel-chatapi

Notification channel Chatapi.

v7.0.9 2023-05-25 19:41 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

MIT

• Jose Galindo

README

This package makes it easy to send [Chatapi notifications] with Laravel

Installation

Contents

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

Installation

You can install the package via composer:

composer require csgt/notification-channel-chatapi

You must install the service provider:

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

Setting up your Chatapi account

Add your URL, Token and Format ('form_params' default or 'json') in config/services.php:

// config/services.php
...
'chatapi' => [
    'url'   => env('CHATAPI_URL'),
    'token' => env('CHATAPI_TOKEN'),
    'format' => env('CHATAPI_FORMAT')
],
...

It is important to note that the CHATAPI_URL env variable must have a trailing slash.

Usage

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

use NotificationChannels\Chatapi\ChatapiChannel;
use NotificationChannels\Chatapi\ChatapiMessage;
use Illuminate\Notifications\Notification;

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

    public function toChatapi($notifiable)
    {
        return (new ChatapiMessage())
            ->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 routeNotificationForChatapi method to your Notifiable model.

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

Available Message methods

ChatapiSmsMessage

• 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

• CS

License

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