laravel-notification-channels/cmsms

CMSMS notification channel for Laravel 5 and up

3.4.0 2024-03-22 08:49 UTC

Requires

• php: ^8.2
• ext-simplexml: *
• guzzlehttp/guzzle: ^7.1
• illuminate/notifications: ^10.0||^11.0
• illuminate/support: ^10.0|^11.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.6
• mockery/mockery: ^1.5
• orchestra/testbench: ^8.0|^9.0
• phpunit/phpunit: ^10.5|^11.0

MIT

• Michel Bardelmeijer

README

This package makes it easy to send CMSMS messages with Laravel.

Contents

• Requirements
• Installation
• Setting up your CMSMS account
• Usage
  • Available message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Requirements

• Sign up for a online sms gateway account
• Find your API key in account settings

Installation

You can install the package via composer:

composer require laravel-notification-channels/cmsms

This package will register itself automatically with Laravel 5.5 and up trough Package auto-discovery.

Manual installation

You can install the service provider for Laravel 5.4 and below:

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

Setting up your CMSMS account

Add your CMSMS Product Token and default originator (name or number of sender) to your config/services.php:

// config/services.php
...
'cmsms' => [
    'product_token' => env('CMSMS_PRODUCT_TOKEN'),
    'originator' => env('CMSMS_ORIGINATOR'),
],
...

Notice: The originator can contain a maximum of 11 alphanumeric characters.

Usage

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

use NotificationChannels\Cmsms\CmsmsMessage;
use Illuminate\Notifications\Notification;

class VpsServerOrdered extends Notification
{
    public function via($notifiable)
    {
        return ['cmsms'];
    }

    public function toCmsms($notifiable)
    {
        return CmsmsMessage::create("Your {$notifiable->service} was ordered!");
    }
}

In order to let your Notification know which phone numer you are targeting, add the routeNotificationForCmsms method to your Notifiable model.

Important note: CMCMS requires the recipients phone number to be in international format. For instance: 0031612345678

public function routeNotificationForCmsms()
{
    return '0031612345678';
}

Available message methods

• body(''): Accepts a string value for the message body.
• originator(''): Accepts a string value between 1 and 11 characters, used as the message sender name.
• reference(''): Accepts a string value for your message reference. This information will be returned in a status report so you can match the message and it's status. Restrictions: 1 - 32 alphanumeric characters. Reference will not work for demo accounts.
• tariff(): Accepts a integer value for your message tariff. The unit is eurocent. Requires the originator to be set to a specific value. Contact CM for this tariff value. CM also must enable this feature for your contract manually.
• multipart($minimum, $maximum): Accepts a 0 to 8 integer range which allows multipart messages. See the documentation from CM for more information.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Michel Bardelmeijer
• All Contributors

Special thanks to Peter Steenbergen for the MessageBird template from where this is mostly based on.

License

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