README

A wrapper for Twilio SMS notification for Laravel. Take a look at contributing.md to see a to do list.

Installation

Via Composer

$ composer require carropublic/laraveltwilio

Run the following vendor publish to publish Twillo config.

php artisan vendor:publish --tag=laraveltwilio.config

Update your .env for Twilio config in order to send out the SMS notification.

Usage

LaravelNotification

The following is the example usage of the package with Laravel's Notification.

Create Notification Class

class ExampleNotification extends Notification
{
    // Which channel this notification should be sent to
    public function via($notifiable)
    {
        return [ SMSChannel::class, WhatsAppChannel::class ];
    }
    
    // Notification payload (content) will be sent
    public function toSMS($notifiable)
    {
        return new LaravelTwilioMessage("Message Content");
    }
    
    // Notification payload (content) will be sent
    public function toWhatsApp($notifiable)
    {
        return new LaravelTwilioMessage("Message Content");
    }
}

Create Notifiable Class

class Contact extends Model {

    use Notifiable;
    
    // Phone number to receive
    public function routeNotificationForSms()
    {
        return $this->phone;
    }
    
    // Phone number to receive
    public function routeNotificationForWhatsapp()
    {
        return $this->phone;
    }
}

Sending Notification from Notifiable Instance

$contact->notify(new ExampleNotification());

Sending Notification from Anonymous Notifiable Instance

Notification::route('sms')->notify(new ExampleNotification());

Check incoming messages from Twilio

When using webhook, you can validate the incoming request is from Twilio. $token is config('laraveltwilio.auth_token'). We are not using directly becuase it might be dynamic.

use CarroPublic\LaravelTwilio\Request\ValidateTwilioIncomingRequestSignature;

ValidateSignatureOfRequest::isValidRequest($token, $request);

Sandbox Mode

How to enable SandBox Mode

Register Closure to return if testing is enabled \CarroPublic\LaravelTwilio\LaravelTwilioManager::registerTestingValidator

Example:

LaravelTwilioManager::registerSandboxValidator(function () {
    return !is_production();
});

Otherwise, useTWILIO_TESTING_ENABLE to determine if running in sandbox mode. Default false

How to bypass sandbox $phone validator

Register Closure to return if sandbox is enabled \CarroPublic\LaravelTwilio\LaravelTwilioSender::registerValidPhoneForSandbox

Example:

LaravelTwilioSender::registerValidPhoneForSandbox(function ($phoneNumber) {
    return $phoneNumber == "+84111111111";
}

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits

License

Please see the license file for more information.

carropublic / laraveltwilio

Maintainers

Details