shiroamada/gosms

GoSMS Notifications channel for Laravel 5.3.

GoSms notifications channel for Laravel 5.3+

, _(*1)

This package makes it easy to send notifications using https://gosms.com.my with Laravel 5.3+., _(*2)

Code Reference from laravel-notification-channels/smsc-ru, _(*3)

Contents

• Installation
  • Setting up the GoSMS service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

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

composer require shiroamada/gosms

Then you must install the service provider:, _(*5)

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

Setting up the GoSMS service

Add your gosms.com.my login, secret key (hashed password) and default sender name (or phone number) to your config/services.php:, _(*6)

// config/services.php
...
'gosms' => [
    'company'   => env('GOSMS_COMPANY'),
    'username'  => env('GOSMS_USERNAME'),
    'password'  => env('GOSMS_PASSWORD'),
    'sender'    => env('GOSMS_SENDER'),
    'gateway'   => env('GOSMS_GATEWAY', 'L'),
    'mode'      => env('GOSMS_MODE', 'BUK'),
    'type'      => env('GOSMS_TYPE', 'TX'),
    'charge'    => env('GOSMS_CHARGE', '0'),
    'maskid'    => env('GOSMS_MASKID', '1'),
    'convert'   => env('GOSMS_CONVERT', '0')
],
...

Usage

You can use the channel in your via() method inside the notification:, _(*7)

use Illuminate\Notifications\Notification;
use NotificationChannels\GoSms\GoSmsMessage;
use NotificationChannels\GoSms\GoSmsChannel;

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

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

In your notifiable model, make sure to include a routeNotificationForGoSms() method, which return the phone number., _(*8)

public function routeNotificationForGoSms()
{
    return $this->mobile; //depend what is your db field
}

Available methods

from(): Sets the sender's name or phone number., _(*9)

content(): Set a content of the notification message., _(*10)

sendAt(): Set a time for scheduling the notification message., _(*11)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*12)

Testing

bash $ composer test, _(*13)

Security

If you discover any security related issues, please use the issue tracker., _(*14)

Contributing

Please see CONTRIBUTING for details., _(*15)

Credits

• ShiroAmada
• JhaoDa
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*16)