laravel-notification-channels/clickatell

Clickatell notifications driver

Clickatell notifications channel for Laravel

, _(*1)

This package makes it easy to send notifications using clickatell.com with Laravel 5.5+, 6.x, 7.x & 8.x., _(*2)

Contents

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

Installation

You can install the package via composer:, _(*3)

composer require laravel-notification-channels/clickatell

Setting up the clickatell service

Add your Clickatell user, password and api identifier to your config/services.php:, _(*4)

// config/services.php
...
'clickatell' => [
    'user'  => env('CLICKATELL_USER'),
    'pass' => env('CLICKATELL_PASS'),
    'api_id' => env('CLICKATELL_API_ID'),
],
...

Usage

To route Clickatell notifications to the proper phone number, define a routeNotificationForClickatell method on your notifiable entity:, _(*5)

class User extends Authenticatable
{
    use Notifiable;

    /**
     * Route notifications for the Nexmo channel.
     *
     * @param  \Illuminate\Notifications\Notification  $notification
     * @return string
     */
    public function routeNotificationForClickatell($notification)
    {
        return $this->phone_number; 
    }
}

You can use the channel in your via() method inside the notification:, _(*6)

use Illuminate\Notifications\Notification;
use NotificationChannels\Clickatell\ClickatellMessage;
use NotificationChannels\Clickatell\ClickatellChannel;

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

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

Available methods

TODO, _(*7)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*8)

Testing

bash $ composer test, _(*9)

Security

If you discover any security related issues, please email hello@etiennemarais.co.za instead of using the issue tracker., _(*10)

Contributing

Please see CONTRIBUTING for details., _(*11)

Credits

• etiennemarais
• arcturial
  • For the Clickatell Client implementation which I leverage on for this wrapper

License

The MIT License (MIT). Please see License File for more information., _(*12)