luisdalmolin/laravel-zenvia-channel

Send SMS messages with Zenvia

Zenvia Notifications Channel for Laravel 5

, _(*1)

This package makes it easy to send Zenvia SMS messages using Zenvia API with Laravel 5., _(*2)

Contents

• Installation
• Configuration
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

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

``` bash composer require luisdalmolin/laravel-zenvia-channel, <sub>(*4)</sub>

You must install the service provider:

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

Configuration

Configure your credentials:, <sub>(*5)</sub>

// config/services.php
...
'zenvia' => [
    'from'    => env('ZENVIA_FROM', 'Laravel Notification Channels'),
    'pretend' => env('ZENVIA_PRETEND', false),
    'conta'   => env('ZENVIA_CONTA', 'YOUR ACCOUNT'),
    'senha'   => env('ZENVIA_SENHA', 'YOUR PASSWORD')
],
...

Usage

You can now use the channel in your via() method inside the Notification class., <sub>(*6)</sub>

``` php use NotificationChannels\Zenvia\ZenviaChannel; use NotificationChannels\Zenvia\ZenviaMessage; use Illuminate\Notifications\Notification;, <sub>(*7)</sub>

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

public function toZenvia($notifiable)
{
    return ZenviaMessage::create()
        ->from('Laravel') // optional
        ->to($notifiable->phone) // your user phone
        ->content('Your invoice has been paid')
        ->id('your-sms-id');
}

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

### Routing a message

You can either send the notification by providing with the chat id of the recipient to the to($phone) method like shown in the above example or add a routeNotificationForZenvia() method in your notifiable model:

```php
...
/**
 * Route notifications for the Telegram channel.
 *
 * @return int
 */
public function routeNotificationForZenvia()
{
    return $this->phone;
}
...

Available Message methods

• to($phone): (integer) Recipient's phone.
• content('message'): (string) SMS message.
• from('Sender'): (string) Sender's name.
• id('sms-id'): (string) SMS ID.

Changelog

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

Testing

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

Security

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

Contributing

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

Credits

• Luís Dalmolin
• All Contributors

License

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