shiroamada/gosms

GoSMS Notifications channel for Laravel 5.3 and Above

1.1.1 2022-03-03 01:20 UTC

Requires

• php: >=7.3
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.0.1
• illuminate/notifications: 5.1 - 5.8|^6.0|^7.0|^8.0
• illuminate/queue: 5.1 - 5.8|^6.0|^7.0|^8.0
• illuminate/support: 5.1 - 5.8|^6.0|^7.0|^8.0

Requires (Dev)

• mockery/mockery: ^1.3.1
• phpunit/phpunit: ^9.0

MIT

• Shiro Amada

• notifications
• laravel
• gosms

README

This package makes it easy to send notifications using https://gosms.com.my with Laravel 5.3+.

Code Reference from laravel-notification-channels/smsc-ru

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:

composer require shiroamada/gosms

Then you must install the service provider:

// 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:

// 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:

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.

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

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 use the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• ShiroAmada
• JhaoDa
• All Contributors

License

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