forss/laravel-forss-sms-notifications

SMS Notification Driver for sms.forss.net

1.0.1 2023-06-21 13:49 UTC

Requires

• guzzlehttp/guzzle: ^7.7

OSL-3.0

• Andreas Strömgren
• Markus Moqvist

README

Setting up the forss API service

Extend config/services.php to read your Forss SMS API credentials from your .env:

return [
    ...

    'forss_sms' => [
        'username' => env('FORSS_SMS_USERNAME'),
        'password' => env('FORSS_SMS_PASSWORD'),
        'sender' => env('FORSS_SMS_SENDER'),
    ]
];

Add your Forss SMS API credentials to your .env:

FORSS_SMS_USERNAME=username
FORSS_SMS_PASSWORD=password
FORSS_SMS_SENDER=sender

Usage

Create a notification

Add a toForssSms method to your Notification class:

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Forss\Laravel\Notifications\ForssSms\ForssSmsMessage;
use Forss\Laravel\Notifications\ForssSms\ForssSmsChannel;
class TestSms extends Notification
{
    use Queueable;

    /**
     * Create a new notification instance.
     */
    public function __construct()
    {
        //
    }

    /**
     * Get the notification's delivery channels.
     *
     * @return array<int, string>
     */
    public function via(object $notifiable): array
    {
        return [ForssSmsChannel::class];
    }

 

    public function toForssSms() {
        return ForssSmsMessage::create('Hello World');
    }

}

Add a routeNotificationForForssSms method to your Notifiable class:

class User extends Authenticatable
{
    use Notifiable;

    public function routeNotificationForForssSms()
    {
        //Return whatever phone number to use for the SMS
        return $this->phone;
    }
}