NCLOUD SENS notifications channel for Laravel

This package makes it easy to send notification using ncloud sens with Laravel.

Installation

Note: laravel-sens requires PHP 7.2+ and Laravel 5.3+ (also Laravel 6.0+ and 7.0+ is compatible)

You can install the package via composer:

composer require seungmun/laravel-sens

The package will automatically register itself.

You can publish the config with:

php artisan vendor:publish --provider="Seungmun\Sens\SensServiceProvider" --tag="config"

Also, you can use it without publish the config file can be used simply by adding environment variables with:

SENS_SERVICE_ID=your-sens-service-id
SENS_ACCESS_KEY=your-sens-access-key
SENS_SECRET_KEY=your-sens-secret-key

Usage

This package can be used using with the Laravel default notification feature.

1) Request to send a SMS

php artisan make:notification SendPurchaseReceipt

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Seungmun\Sens\Sms\SmsChannel;
use Seungmun\Sens\Sms\SmsMessage;
use Illuminate\Notifications\Notification;

class SendPurchaseReceipt extends Notification
{
    use Queueable;

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [SmsChannel::class];
    }

    /**
     * Get the sens sms representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Seungmun\Sens\Sms\SmsMessage
     */
    public function toSms($notifiable)
    {
        return (new SmsMessage)
            ->to($notifiable->phone)
            ->from('055-000-0000')
            ->content('Welcome: https://open.kakao.com/o/g3dWlf0')
            ->contentType('AD')// You can ignore it (default: COMM)
            ->type('SMS');  // You can ignore it (default: SMS)
    }
}

$user = \App\User::find(1);
$user->notify(new \App\Notifications\SendPurchaseReceipt);

2) Request to send MMS

php artisan make:notification SendPurchaseInvoice

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Http\UploadedFile;
use Seungmun\Sens\Sms\SmsChannel;
use Seungmun\Sens\Sms\SmsMessage;
use Illuminate\Notifications\Notification;

class SendPurchaseInvoice extends Notification
{
    use Queueable;
    
    /** @var \Illuminate\Http\UploadedFile */
    private $image;
    
    /**
     * Create a new notification instance.
     *
     * @param  \Illuminate\Http\UploadedFile  $image
     */
    public function __construct(UploadedFile $image)
    {
        $this->image = $image;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [SmsChannel::class];
    }

    /**
     * Get the sens sms representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Seungmun\Sens\Sms\SmsMessage
     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
     */
    public function toSms($notifiable)
    {
        return (new SmsMessage)
            ->type('MMS')
            ->to($notifiable->phone)
            ->from('055-000-0000')
            ->content('This is your invoice.\nCheck out the attached image.')
            /* file's path string or UploadedFile object of Illuminate are allowed */
            ->file('filename.jpg', $this->image);
    }
}

$user = \App\User::find(1);

// In this case, you should only pass UploadedFile object as a parameter.
// If when you need to pass a file path string as a parameter, change your notification class up.
$user->notify(new \App\Notifications\SendPurchaseReceipt(request()->file('image)));

Now User id: 1 which has own phone attribute would receive a sms or mms message soon.

Features

SMS(LMS) and MMS

Unfortunately you can approach to only SMS related feature currently.

Todo

Mobile push notification
Kakao business message

It will gradually provide all other services.