README

This package makes it easy to send notifications using smsc.ru (aka СМС–Центр) with Laravel 5.3+.

Installation
- Setting up the SmscRu service
Usage
- Available Message methods
Changelog
Testing
Security
Contributing
Credits
License

Installation

Install this package with Composer:

composer require laravel-notification-channels/smsc-ru

If you're using Laravel 5.x you'll also need to specify a version constraint:

composer require laravel-notification-channels/smsc-ru -v 2.0.3

The service provider gets loaded automatically. Or you can do this manually:

// config/app.php
'providers' => [
    ...
    NotificationChannels\SmscRu\SmscRuServiceProvider::class,
],

Setting up the SmscRu service

Add your SmscRu login, secret key (hashed password) and default sender name (or phone number) to your config/services.php:

// config/services.php
...
'smscru' => [
    'login'  => env('SMSCRU_LOGIN'),
    'secret' => env('SMSCRU_SECRET'),
    'sender' => 'John_Doe',
    'extra'  => [
        // any other API parameters
        // 'tinyurl' => 1
    ],
],
...

If you want use other host than smsc.ru, you MUST set custom host WITH trailing slash.

// .env
...
SMSCRU_HOST=http://www1.smsc.kz/
...

// config/services.php
...
'smscru' => [
    ...
    'host' => env('SMSCRU_HOST'),
    ...
],
...

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\SmscRu\SmscRuMessage;
use NotificationChannels\SmscRu\SmscRuChannel;

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

    public function toSmscRu($notifiable)
    {
        return SmscRuMessage::create("Task #{$notifiable->id} is complete!");
    }
}

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

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

Available methods

from(): Sets the sender's name or phone number.

content(): Set a content of the notification message.

sendAt(): Set a time for scheduling the notification message.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

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

laravel-notification-channels / smsc-ru

Maintainers

Details

README

Contents