README

This package makes it easy to send notifications using jsksms with Laravel 5.5+, 6.x, 7.x and 8.x

Installation
- Setting up the jsksms
Usage
- Available Message methods
- On-Demand Notifications
Changelog
Testing
Security
Contributing
Credits
License

Installation

You can install this package via composer:

composer require ramanandapanda/jsksms

Setting up the jsksms service

Add your jsksms token, default sender name (or phone number) to your config/services.php:

// config/services.php
...
'jsksms' => [
    'endpoint' => env('jsksms_ENDPOINT', 'https://jsksms.com/api/v2/send'),
    'token' => env('jsksms_TOKEN', 'YOUR jsksms TOKEN HERE'),
    'sender' => env('jsksms_SENDER', 'YOUR jsksms SENDER HERE')
],
...

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\jsksms\JsksmsMessage;

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

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

In your notifiable model, make sure to include a routeNotificationForjsksms() method, which returns a phone number or an array of phone numbers.

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

On-Demand Notifications

Sometimes you may need to send a notification to someone who is not stored as a "user" of your application. Using the Notification::route method, you may specify ad-hoc notification routing information before sending the notification:

Notification::route('jsksms', '5555555555')                      
            ->notify(new InvoicePaid($invoice));

Available Message methods

sender(): Sets the sender's name. Make sure to register the sender name at you jsksms dashboard.

content(): Set a content of the notification message. This parameter should be no longer than 918 char(6 message parts),

test(): Send a test message to specific mobile number or not. This parameter should be boolean and default value is true.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please use the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

ramanandapanda / jsksms

Maintainers

Details