canerdogan / twilio-notification-channel
A boilerplate for contributions.
Requires
- php: >=5.6.4
- illuminate/events: ^5.3
- illuminate/notifications: ^5.3
- illuminate/queue: ^5.3
- illuminate/support: ^5.3
- twilio/sdk: ^5.16.2
Requires (Dev)
- mockery/mockery: ^0.9.5
- phpunit/phpunit: 4.*
README
This package makes it easy to send Twilio notifications with Laravel 5.3.
Contents
Installation
You can install the package via composer:
composer require laravel-notification-channels/twilio
You must install the service provider:
// 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
:
// config/services.php ... 'twilio' => [ 'account_sid' => env('TWILIO_ACCOUNT_SID'), 'auth_token' => env('TWILIO_AUTH_TOKEN'), 'from' => env('TWILIO_FROM'), // optional ], ...
Usage
Now you can use the channel in your via()
method inside the notification:
use NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\TwilioSmsMessage; use Illuminate\Notifications\Notification; class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; } public function toTwilio($notifiable) { return (new TwilioSmsMessage()) ->content("Your {$notifiable->service} account was approved!"); } }
You can also create a Twilio call:
use NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\TwilioCallMessage; use Illuminate\Notifications\Notification; class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; } public function toTwilio($notifiable) { return (new TwilioCallMessage()) ->url("http://example.com/your-twiml-url"); } }
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.
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.
Testing
$ composer test
Security
If you discover any security related issues, please email gregoriohc@gmail.com instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.