flickerleap/clickatell

Laravel Notification integration for Clickatell

Maintainers

Details

github.com/flickerleap/clickatell

Source

Issues

Installs: 105

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 4

Forks: 0

Open Issues: 0

1.0.5 2023-04-13 07:49 UTC

Requires

MIT 1a68e22c7d26b9e56f1fe0c90aa3906250d1511b

This package is not auto-updated.

Last update: 2024-04-14 02:24:25 UTC

README

This package implements Clickatell as a Laravel notification channel.

We drew a lot of inspiration from laravel-notification-channels/clickatell

Contents

Installation

composer require flickerleap/clickatell

.env

CLICKATELL_TOKEN=

Publish

php artisan vendor:publish --provider="FlickerLeap\Clickatell\ClickatellServiceProvider"

Configuration

Default to

CLICKATELL_FIELD=
  • CLICKATELL_FIELD - The default field to use for the to if the routeNotificationForClickatell() method is not implemented on the notifiable class.

Tracking

Optional tracking logs the send status from Clickatell. php artisan migrate needs to be run once enabled.

CLICKATELL_TRACK=
CLICKATELL_TRACKING_TABLE=
  • CLICKATELL_TRACK - Tracking true of false.
  • CLICKATELL_TRACKING_TABLE - Optional table name for tracking.

Callback

Optionally, with delivery notifications enabled, set the credentials and URL here. Tracking needs to be enabled. A value of /clickatellCallback would be accessed at https://mysite.com/clickatellCallback

CLICKATELL_CALLBACK_URL=
CLICKATELL_USERNAME=
CLICKATELL_PASSWORD=
  • CLICKATELL_CALLBACK_URL - Callback URL for message delivery updates.
  • CLICKATELL_USERNAME - Callback credentials.
  • CLICKATELL_PASSWORD - Callback credentials.

Usage

Notifiable

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;

class User extends Model
{
    use Notifiable;

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

Notification

<?php

namespace App\Notifications;

use FlickerLeap\Clickatell\ClickatellChannel;
use FlickerLeap\Clickatell\ClickatellMessage;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class SMSUser extends Notification implements ShouldQueue
{
    use Queueable;

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [ClickatellChannel::class];
    }

    /**
     * @param $notifiable
     * @return \FlickerLeap\Clickatell\ClickatellMessage
     */
    public function toClickatell($notifiable)
    {
        $content = 'My message.';

        return (new ClickatellMessage())->content($content);
    }

}

To

Optionally the to field can be dynamically changed per call by specifying ->to()

    /**
     * @param $notifiable
     * @return \FlickerLeap\Clickatell\ClickatellMessage
     */
    public function toClickatell($notifiable)
    {
        $content = 'My message.';

        return (new ClickatellMessage())->to($notifiable->beneficiary_number)
            ->content($content);
    }

Call

$user->notify(new SMSUser());

Testing

If APP_ENV is set to local, laravel log entries will be created.

Tests

TODO

Credits