Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vaibhavpandeyvpz/msg91-php
PHP client for sending SMS/OTP using MSG91, includes optional support for Laravel.
https://github.com/vaibhavpandeyvpz/msg91-php
laravel msg91 sms
Last synced: 4 days ago
JSON representation
PHP client for sending SMS/OTP using MSG91, includes optional support for Laravel.
- Host: GitHub
- URL: https://github.com/vaibhavpandeyvpz/msg91-php
- Owner: vaibhavpandeyvpz
- License: mit
- Created: 2020-11-30T17:21:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-25T04:38:33.000Z (about 2 years ago)
- Last Synced: 2024-05-03T03:53:19.478Z (6 months ago)
- Topics: laravel, msg91, sms
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vaibhavpandeyvpz/msg91
PHP client for sending SMS/OTP using MSG91, includes optional support for Laravel.
### Installation
```bash
composer require vaibhavpandeyvpz/msg91
```
#### Laravel < 5.5
Once the package is installed, open your `app/config/app.php` configuration file and locate the `providers` key. Add the following line to the end:
```php
Msg91\Laravel\ServiceProvider::class
```
Next, locate the `aliases` key and add the following line:
```php
'Msg91' => Msg91\Laravel\Facade::class,
```
### Configuration
You need to add `MSG91_KEY` in your project's `.env` file. You can also publish the default configuration file as `config/msg91.php` using below command.
```bash
$ php artisan vendor:publish
```
### Usage
## Basic
- Send an SMS to one or more numbers.
```php
'',
]
);
// send same/different SMS to multiple numbers
$result = Msg91::sms(
null,
[
['to' => ['919999999999', '918888888888'], 'message' => 'Hello fellas!'],
['to' => ['917777777777'], 'message' => 'Hello vpz!'],
],
'MSGIND',
4 /* 1 = Promotional; 4 = Transactional */,
[
'DLT_TE_ID' => '',
]
);
```
- Send OTP to a number.
```php
'',
]);
```
- Retry OTP (as voice) to a number.
```php
message(__('This is just a test message.'))
->sender('MSGIND')
->transactional()
->options([
'DLT_TE_ID' => '',
]);
}
```
Implement `routeNotificationForMsg91` method in your notifiable class:
```php
phone;
}
```
Finally send the notification:
```php
notify(new App\Notifications\Msg91TestNotification());
```
For sending the notification to an arbitrary number, use below syntax:
```php
notify(new App\Notifications\Msg91TestNotification());
```
## Validator
You can validate sent OTPs using provided validation rule named `msg91_otp` as shown below:
```php
'919999999999', 'otp' => '1234'];
$validator = Validator::make($data, [
'phone' => ['required', 'digits_between:10,12'],
'otp' => ['required', 'digits:4', 'msg91_otp'], // default key for source number is 'phone', you can customize this using 'msg91_otp:key_name'
]);
if ($validator->fails()) {
// report errors
}
```
### License
See [LICENSE](LICENSE) file.