shiroamada/ultrasms-laravel-notification

UltraSMS Notifications channel for Laravel 5.3 and Above

v2.0.2 2023-07-07 15:15 UTC

Requires

• php: ^7.3|^8.0
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• illuminate/notifications: 5.1 - 5.8|^6.0|^7.0|^8.0|^9.0|^10.0
• illuminate/queue: 5.1 - 5.8|^6.0|^7.0|^8.0|^9.0|^10.0
• illuminate/support: 5.1 - 5.8|^6.0|^7.0|^8.0|^9.0|^10.0

Requires (Dev)

• mockery/mockery: ^1.3.1
• phpunit/phpunit: ^9.3

MIT

• Shiro Amada

• notifications
• laravel
• ultrasms

README

This package makes it easy to send notifications using https://ultramsg.com/ with Laravel 5.3+.

Code Reference from laravel-notification-channels/smsc-ru

Contents

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

Installation

You can install the package via composer:

composer require shiroamada/ultrasms-laravel-notification

Then you must install the service provider:

// config/app.php
'providers' => [
    ...
    NotificationChannels\UltraSms\UltraSmsServiceProvider::class,
],

Setting up the UltraSMS service

Add your ultrasms instanceId and token to your config/services.php:

// config/services.php
...
'ultrasms' => [
    'isEnable' => env('ULTRASMS_ENABLE') ?? 0,
    'instanceId' => env('ULTRASMS_INSTANCEID'),
    'token' => env('ULTRASMS_TOKEN'),
    'isMalaysiaMode' => env('ULTRASMS_MALAYSIA_MODE') ?? 0,
    'isDebug' => env('ULTRASMS_DEBUG_ENABLE') ?? 0,
    'debugReceiveNumber' => env('ULTRASMS_DEBUG_RECEIVE_NUMBER'),
],
...

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\UltraSms\UltraSmsMessage;
use NotificationChannels\UltraSms\UltraSmsChannel;

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

    public function toUltraSms($notifiable)
    {
        return UltraSmsMessage::create("Task #{$notifiable->id} is complete!");
    }
}

In your notifiable model, make sure to include a routeNotificationForUltraSms() method, which return the phone number.

public function routeNotificationForUltraSms()
{
    return $this->mobile; //depend what is your db field
}

Available methods

content(): Set a content of the notification message.

sendAt(): Set a time for scheduling the notification message.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please use the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• ShiroAmada
• All Contributors

License

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