README

This package makes it easy to send sms via Karix.io with Laravel 5.4+.

Installation

You can install the package via composer:

composer require bitfumes/karix-notification-channel

Setting up the Karix id and token

Login to Karix.io and get your ID and Token, put that on your .env file and add your Karix Id and Token to your config/services.php:

// config/services.php
...
    'karix' => [
        'id' => env('KARIX_ID'),
        'token' => env('KARIX_TOKEN'),
    ],
...

Usage

Now you can use the channel in your via() method inside the notification:

use Bitfumes\KarixNotificationChannel\KarixChannel;
use Bitfumes\KarixNotificationChannel\KarixMessage;
use Illuminate\Notifications\Notification;

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

    public function toKarix($notifiable)
    {
        return KarixMessage::create()
                        ->from('+1XXXXXXXXXX')
                        ->content('Your message comes here');
    }
}

In order to let your Notification know that there is a new channel called KarixSmsChannel, add the routeNotificationForKarix method to your Notifiable model (probably your user.php file).

This method needs to return email of the user (if it's a private board) and the list ID of the Trello list to add the card to.

Caveat : Make sure you have a 'phone' field in your table along with country code like +91xxxxxxxxxx for which you are using this.

public function routeNotificationForKarix()
{
    return $this->phone;
}

Available methods

version(''): Accepts a string value for the Karix api version.
timezone(''): Accepts a string value for the TimeZone if you want to set for sms.

Testing

$ composer test

Security

If you discover any security related issues, please email sarthak@bitfumes.com instead of using the issue tracker.

bitfumes / karix-notification-channel

Maintainers

Details