README

A Laravel Notification channel for sending SMS messages with Twilio.

Installation

You can install the package via composer:

composer require clevyr/laravel-twilio-channel

Configure an account on Twilio, and then add the following env vars:

TWILIO_SID=
TWILIO_AUTH_TOKEN=
TWILIO_PHONE_NUMBER=

Next, publish the config file with:

php artisan vendor:publish --provider="Clevyr\LaravelTwilioChannel\LaravelTwilioChannelServiceProvider"

This is the contents of the published config file (without descriptive comments):

return [
    'sid' => env('TWILIO_SID'),
    'auth_token' => env('TWILIO_AUTH_TOKEN'),
    'phone_number' => env('TWILIO_PHONE_NUMBER'),
];

Usage

In your Laravel notifications:

Implement the TwilioNotification interface
Add the TwilioChannel to your via return array value
Build a toTwilio function that returns a TwilioMessage object

By default, the Twilio Channel will use your notifiable's phone_number field to send a phone number, which must be in a format such as 18884445555. See below how to override this.

<?php

namespace App\Notifications;

use Clevyr\LaravelTwilioChannel\Channels\TwilioChannel;
use Clevyr\LaravelTwilioChannel\Contracts\TwilioNotification;
use Clevyr\LaravelTwilioChannel\Messages\TwilioMessage;
use Illuminate\Notifications\Notification;

class MyNotification extends Notification implements TwilioNotification {

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [TwilioChannel::class];
    }

    /**
     * Get the twilio representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Clevyr\LaravelTwilioChannel\Messages\TwilioMessage
     */
    public function toTwilio($notifiable)
    {
        return (new TwilioMessage)
            ->line('Your first line.')
            ->line('A second line, with a break between the last line.');
    }

Overriding the Notifiable Phone Number Field

By default, TwilioChannel will use your notifiable's phone_number field to send an SMS message. To override this and use a different field, set the twilioPhoneNumberField instance variable in your notifiable class:

class User extends Authenticatable
{
    public $twilioPhoneNumberField = 'primary_phone_number';

    //
}

Now if you generate a notification from a `User` object, `TwilioChannel`
will use the user's `primary_phone_number` field to send messages.

Testing

composer test

Linting

composer analyse

Formatting w/ Laravel Pint

composer format

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

clevyr / laravel-twilio-channel

Maintainers

Details