README

Prerequisites

Before you can send notifications via SMSFactor, you need to install the xefi/sms-factor-notification-channel

composer require xefi/sms-factor-notification-channel

The package includes a configuration file. However, you are not required to export this configuration file to your own application. You can simply use the SMS_FACTOR_TOKEN environment variables to define your SMSFactor token.

SMS_FACTOR_TOKEN=your-token

Notification channel

In order to configure the notification to deliver via the SMSFactor channel, you need to specify this in the via method of your notification:

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

Formating SMS Notifications

If a notification supports being sent as an SMS, you should define a toSmsFactor method on the notification class. This method will receive a $notifiable entity and should return an Xefi\SmsFactor\Messages\SmsFactorMessage instance:

use Xefi\SmsFactor\Messages\SmsFactorMessage;
 
/**
 * Get the SMSFactor representation of the notification.
 */
public function toSmsFactor(object $notifiable): SmsFactorMessage
{
    return (new SmsFactorMessage)
                ->text('Your SMS message content');
}

Customizing the "To" Number

If you would like to customize the number depending on the notifiable object you are calling, you'll need to implement the routeNotificationForSmsFactor method on your notifiable model:

use Illuminate\Notifications\Notification;

/**
 * Get the corresponding phone number for the current model.
 */
public function routeNotificationForSmsFactor(Notification $notification)
{
    return $this->phone;
}

Customizing the "From" Number

If you would like to send some notifications from a phone number that is different from the phone number specified by your SMS_FACTOR_SMS_FROM environment variable, you may call the sender method on a SmsFactorMessage instance:

use Xefi\SmsFactor\Messages\SmsFactorMessage;
 
/**
 * Get the SMSFactor representation of the notification.
 */
public function toSmsFactor(object $notifiable): SmsFactorMessage
{
    return (new SmsFactorMessage)
                ->content('Your SMS message content')
                ->sender('15554443333');
}

Support us

Since 1997, XEFI is a leader in IT performance support for small and medium-sized businesses through its nearly 200 local agencies based in France, Belgium, Switzerland and Spain. A one-stop shop for IT, office automation, software, digitalization, print and cloud needs. Want to work with us ?

xefi / sms-factor-notification-channel

Maintainers

Details