This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Send Laravel Notifications via the Vodafone SMS API

1.2.0 2020-12-29 01:09 UTC

This package is auto-updated.

Last update: 2021-05-29 01:31:44 UTC


README

Latest Version on Packagist Software License Build Status StyleCI Quality Score Code Coverage Total Downloads

This package makes it easy to send sms notifications using Vodafone with Laravel 5.5+ and 6.x

Building on Laravel's Notification channel, this package allows you to send SMS notifications via the Vodafone SMS gateway service.

Sending an SMS to a user becomes as simple as using:

$user->notify(new Notification())

Contents

Installation

Install the package using composer

composer require laravel-notification-channels/vodafone

Add the configuration to your services.php config file:

'vodafone' => [
    'username' => env('VODAFONE_USERNAME'),
    'password' => env('VODAFONE_PASSWORD'),
]

Setting up the Vodafone service

Using the Vodafone SMS service requires an account with Vodafone, which can be arranged from this location: https://www.vodafone.com.au/messaging/smser

After being provided with your Vodafone account you will receive an API username and password, these need to be entered into your env or config file.

The Vodafone service has the option to send messages with an alpha tag so instead of appearing from a miscellaneous number they come from a pre-defined name.

Usage

Sending Text Message

Within your notification you need to add the Vodafone channel to your via() method:

use Illuminate\Notifications\Notification;
use NotificationChannels\Vodafone\VodafoneChannel;
use NotificationChannels\Vodafone\VodafoneMessage;

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

    public function toVodafone($notifiable)
    {
        return (new VodafoneMessage)
            ->content($this->content)
            ->from('My App');
    }

In your notifiable model, make sure to include a routeNotificationForVodafone() method, which should return a full mobile number including country code.

public function routeNotificationForVodafone()
{
    return $this->phone;
}

Available Message methods

content(): Sets the message content of the SMS

from(): Sets the qualified sender of the message

Retrieving Text Messages

The VodafoneClient class comes with a 'receive' method for retrieving messages from the Vodafone server.

Note: It only returns unread messages and once the Vodafone endpoint has been hit all unread messages are then marked as read. So you only have one opportunity to further process incoming messages.

use NotificationChannels\Vodafone\VodafoneClient;

$vc = new VodafoneClient();
$vc->receive();

// A static method is also available
VodafoneClient::getUnread();

Since the Vodafone API only returns one unread message at a time a loop will need to be used to retrieve all the unread messages.

Vodafone will return an Error (code: 201) when there are no more unread messages, so breaking the loop on an Exception means there are no more messages to be retrieved.

use NotificationChannels\Vodafone\VodafoneClient;

$ex = false;
do {
    try {
        $message = VodafoneClient::getUnread();
        // Process Message
    } catch (\Exception $ex) {}
} while (!$ex);

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

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