undjike/camoo-laravel-notification-channel

Laravel Notification Channel based on Camoo SMS service

v1.0.1 2024-05-04 06:07 UTC

Requires

• php: >=8.1
• ext-json: *
• camoo/sms: ^4.1
• illuminate/notifications: >=9.52
• illuminate/support: >=9.52

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^8.0 || ^9.0

MIT

• Ulrich Pascal Ndjike Zoa

• sms
• notification
• laravel
• bulksms
• bulk
• africa
• CAMOO
• Cameroon
• notification channel
• undjike
• camoo notification
• sms notification channel

README

Introduction

This is a package for Laravel applications which enables you to send notifications through Camoo SMS Channel.

The package uses Camoo SMS Service to perform SMS dispatching.

Installation

This package can be installed via composer. Just type :

composer require undjike/camoo-laravel-notification-channel

Usage

After installation, configure your services in congig/services.php by adding :

<?php

return [
    //...

    'camoo' => [
        'key' => env('CAMOO_API_KEY'), // Your credentials 
        'secret' => env('CAMOO_SECRET_KEY')
    ],
];

Once this is done, you can create your notification as usual.

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;
use Undjike\CamooNotificationChannel\CamooChannel;
use Undjike\CamooNotificationChannel\CamooMessage;

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

    /**
     * @param $notifiable
     * @return mixed
     */
    public function toCamoo($notifiable)
    {
        return CamooMessage::create()
            ->body('Type here you message content...')
            ->sender('Brand name');
        // or return 'Type here you message content...';
    }
}

To get this stuff completely working, you need to add this to your notifiable model.

    /**
     * Attribute to use when addressing Camoo SMS notification
     *
     * @returns string|array
     */
    public function routeNotificationForCamoo()
    {
        return $this->phone_number; // Can be a string or an array of valid phone numbers
    }

Enjoy !!!

License

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