A package that makes it easy to send SMS using Hubtel in a Laravel 5.3+ application
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.editorconfig
.gitignore
.styleci.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
composer.json

README.md

Hubtel notification channel for Laravel 5.3+

Latest Stable Version License

This package makes it easy to send notifications using Hubtel with Laravel 5.3+.

Contents

Installation

To get the latest version of Pushbullet Notification channel for Laravel 5.3+, simply require the project using Composer:

$ composer require norris1z/hubtel-laravel-sms-channel

If you use Laravel 5.5+ you don't need the following step. If not, once package is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

  • NotificationChannels\Hubtel\HubtelServiceProvider::class

Setting up the Hubtel service

In your Hubtel account go to Applications page. Click on the details of the desired application and copy your apiKey and apiSecret

In your terminal run

$ php artisan vendor:publish --provider="NotificationChannels\Hubtel\HubtelServiceProvider"

This creates a hubtel.php file in your config directory.

Paste your apiCredentials in the config/hubtel.php configuration file. You may copy the example configuration below to get started:

'account' => [
        'key' => env('HUBTEL_API_KEY'),
        'secret' => env('HUBTEL_API_SECRET')
]

Or

Add the HUBTEL_API_KEY and HUBTEL_API_SECRET to your .env file

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\Hubtel\HubtelChannel;
use NotificationChannels\Hubtel\HubtelMessage;

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

    public function toSMS($notifiable)
    {
        return (new HubtelMessage)
			->from("JabClari")
			->to("2331234567890")
           	 	->content("Kim Kippo... Sup with you");
    }
}

In order to let your Notification know which phone number you are sending to, add the routeNotificationForSMS method to your Notifiable model e.g your User Model

public function routeNotificationForSMS()
{
    return $this->phone; // where phone is a cloumn in your users table;
}

Available Message methods

  • from($from) : set the sender's name or phone number
  • to($to) : set the recipient's phone number
  • content($content) : set the message content
  • registeredDelivery() : set delivery report request
  • clientReference($reference) : set the client reference number
  • type($type) : set the message type to be sent
  • udh($udh) : set the User Data Header of the SMS Message being sent
  • time($time) : set the time to deliver the message
  • flashMessage() : sends the message as a flash message

Read more about the avialable methods on the Hubtel Documentation Page

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email norisjibril@gmail.com instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

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