https://github.com/laravel-notification-channels/touch-sms
📲 TouchSMS Notifications Channel for Laravel
https://github.com/laravel-notification-channels/touch-sms
Last synced: 2 months ago
JSON representation
📲 TouchSMS Notifications Channel for Laravel
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/touch-sms
- Owner: laravel-notification-channels
- License: mit
- Created: 2021-02-18T00:27:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-27T04:11:30.000Z (4 months ago)
- Last Synced: 2025-03-29T03:32:14.633Z (3 months ago)
- Language: PHP
- Size: 24.4 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TouchSMS Notification Channel
[](https://packagist.org/packages/laravel-notification-channels/touch-sms)
[](LICENSE.md)
[](https://travis-ci.org/laravel-notification-channels/touch-sms)
[](https://styleci.io/repos/339892204)
[](https://packagist.org/packages/laravel-notification-channels/touch-sms)
📲 [TouchSMS](https://touchsms.com.au) Notifications Channel for Laravel
## Contents
- [Installation](#installation)
- [Setting up the TouchSms service](#setting-up-the-TouchSms-service)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
```bash
composer require laravel-notification-channels/touch-sms
```
Add the configuration to your `services.php` config file:
```php
'touchsms' => [
'token_id' => env('TOUCHSMS_TOKEN_ID'),
'access_token' => env('TOUCHSMS_ACCESS_TOKEN'),
'default_sender' => env('TOUCHSMS_DEFAULT_SENDER', null),
]
```
### Setting up the TouchSms service
You'll need a TouchSMS account. Head over to their [website](https://www.touchsms.com.au/) and create or login to your account.
Head to `Settings` and then `API keys` in the sidebar to generate a set of API keys.
## Usage
You can use the channel in your `via()` method inside the notification:
```php
use Illuminate\Notifications\Notification;
use \NotificationChannels\TouchSms\TouchSmsMessage;
use \NotificationChannels\TouchSms\TouchSmsChannel;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [TouchSmsChannel::class];
}
public function toTouchsms($notifiable)
{
return (new TouchSmsMessage)
->content("Task #{$notifiable->id} is complete!");
}
}
```
In your notifiable model, make sure to include a `routeNotificationForTouchsms()` method, which returns an australian or new zeland phone number in the international format.
```php
public function routeNotificationForTouchsms()
{
return $this->phone; // 6142345678
}
```
### Available methods
`sender()`: Sets the sender's name or phone number.
`content()`: Set a content of the notification message.
`reference()`: Set the SMS reference code (included with replies/delivery receipt callbacks)
## 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
- [TouchSms](https://github.com/touchsms)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.