chuoke/twilio

A boilerplate for contributions.Forked from laravel-notification-channels/twilio

Twilio notifications channel for Laravel 5.3+

, _(*1)

This package makes it easy to send Twilio notifications with Laravel 5.3., _(*2)

Contents

• Installation
  • Setting up your Twilio account
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:, _(*3)

``` bash composer require laravel-notification-channels/twilio, <sub>(*4)</sub>

Add the service provider (only required on Laravel 5.4 or lower):

```php
// config/app.php
'providers' => [
    ...
    NotificationChannels\Twilio\TwilioProvider::class,
],

Setting up your Twilio account

Add your Twilio Account SID, Auth Token, and From Number (optional) to your config/services.php:, <sub>(*5)</sub>

// config/services.php
...
'twilio' => [
    'username' => env('TWILIO_USERNAME'), // optional when using auth token
    'password' => env('TWILIO_PASSWORD'), // optional when using auth token
    'auth_token' => env('TWILIO_AUTH_TOKEN'), // optional when using username and password
    'account_sid' => env('TWILIO_ACCOUNT_SID'),
    'sms_service_sid' => env('TWILIO_SMS_SERVICE_SID'), // optional
    'from' => env('TWILIO_FROM'), // optional
],
...

Usage

Now you can use the channel in your via() method inside the notification:, <sub>(*6)</sub>

``` php use NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\TwilioSmsMessage; use Illuminate\Notifications\Notification;, <sub>(*7)</sub>

class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; }, <sub>(*8)</sub>

public function toTwilio($notifiable)
{
    return (new TwilioSmsMessage())
        ->content("Your {$notifiable->service} account was approved!");
}

}, <sub>(*9)</sub>

You can also send an MMS:

``` php
use NotificationChannels\Twilio\TwilioChannel;
use NotificationChannels\Twilio\TwilioMmsMessage;
use Illuminate\Notifications\Notification;

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

    public function toTwilio($notifiable)
    {
        return (new TwilioMmsMessage())
            ->content("Your {$notifiable->service} account was approved!")
            ->mediaUrl("https://picsum.photos/300");
    }
}

Or create a Twilio call:, <sub>(*10)</sub>

``` php use NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\TwilioCallMessage; use Illuminate\Notifications\Notification;, <sub>(*11)</sub>

class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; }, <sub>(*12)</sub>

public function toTwilio($notifiable)
{
    return (new TwilioCallMessage())
        ->url("http://example.com/your-twiml-url");
}

}, <sub>(*13)</sub>

And you can also create a Twilio notify:

``` php
use NotificationChannels\Twilio\TwilioChannel;
use NotificationChannels\Twilio\TwilioNotifyMessage;
use Illuminate\Notifications\Notification;

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

    public function toTwilio($notifiable)
    {
        return (new TwilioNotifyMessage())
            // you can change the service sid,and default will use the config's
            // ->setServiceSid('Service Sid')
            ->content('Yes! Your account was approved!');
    }
}

In this case,don't need the from., <sub>(*14)</sub>

In order to let your Notification know which phone are you sending/calling to, the channel will look for the phone_number attribute of the Notifiable model. If you want to override this behaviour, add the routeNotificationForTwilio method to your Notifiable model., <sub>(*15)</sub>

public function routeNotificationForTwilio()
{
    return '+1234567890';
}

Available Message methods

TwilioSmsMessage

• from(''): Accepts a phone to use as the notification sender.
• content(''): Accepts a string value for the notification body.

TwilioCallMessage

• from(''): Accepts a phone to use as the notification sender.
• url(''): Accepts an url for the call TwiML.

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*16)</sub>

Testing

bash $ composer test, <sub>(*17)</sub>

Security

If you discover any security related issues, please email gregoriohc@gmail.com instead of using the issue tracker., <sub>(*18)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*19)</sub>

Credits

• Gregorio Hernández Caso
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*20)</sub>