https://github.com/laravel-notification-channels/cmsms
CMSMS notifications channel for Laravel
https://github.com/laravel-notification-channels/cmsms
Last synced: 2 months ago
JSON representation
CMSMS notifications channel for Laravel
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/cmsms
- Owner: laravel-notification-channels
- License: mit
- Created: 2016-08-31T14:45:44.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-29T15:17:25.000Z (5 months ago)
- Last Synced: 2025-03-29T03:32:14.490Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 103 KB
- Stars: 8
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# CMSMS notifications channel for Laravel
[](https://packagist.org/packages/laravel-notification-channels/cmsms)
[](https://github.com/laravel-notification-channels/cmsms/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/laravel-notification-channels/cmsms)
This package makes it easy to send [CMSMS messages](https://docs.cmtelecom.com/en/api/business-messaging-api/1.0/index) with Laravel.
## Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Setting up your CMSMS account](#setting-up-your-cmsms-account)
- [Usage](#usage)
- [Available message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Requirements
- [Sign up](https://www.cm.com/register/?app=fbb5f379-99d4-4321-b1cc-607e47e9b20a) for a online sms gateway account
- Find your API key in account settings
## Installation
You can install the package via composer:
``` bash
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:
```php
// 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`:
```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:
``` php
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
```php
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.
- `encodingDetectionType('')`: Read about encoding detection here: https://developers.cm.com/messaging/docs/sms#auto-detect-encoding
- `multipart($minimum, $maximum)`: Accepts a 0 to 8 integer range which allows multipart messages. See the [documentation from CM](https://dashboard.onlinesmsgateway.com/docs#send-a-message-multipart) for more information.
### Available events
- `SMSSentSuccessfullyEvent`: This event will be fired after the message was sent. The event will contain the payload we have sent to CM.
- `SMSSendingFailedEvent`: This event will be fired if the message was not sent. The event will contain the response body we received from CM.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Michel Bardelmeijer](https://github.com/mbardelmeijer)
- [All Contributors](../../contributors)
Special thanks to [Peter Steenbergen](http://petericebear.github.io) for the MessageBird template from where this is mostly based on.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.