# DEPRECATED! Please check [MessageWay](https://github.com/MessageWay/MessageWayLaravel)

![DEPRECATED][ico-deprecated]

[ico-deprecated]: https://img.shields.io/badge/-DEPRECATED-red?style=for-the-badge


----

![gsOTP](logo.png)

# LaravelOTP

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]

![فارسی](readme-fa.md)

Send OTP for one-time password and mobile number verification code from various SMS, voicemail, messaging, and smart hybrid channels.
This package allows you to connect to gsOTP.com server from your laravel applications.

## Installation

Via Composer

``` bash
$ composer require globalsmartotp/laravel-otp

#Or if using Laravel Sail
$ sail composer require globalsmartotp/laravel-otp
```

Publish
``` bash
$ php artisan vendor:publish --tag=laravel-otp.config

#Or if using Laravel Sail
$ sail artisan vendor:publish --tag=laravel-otp.config
```

## Usage
### ApiKey
Please register on [gsOTP.com](https://gsotp.com) and get `apiKey`
### Environment
Please add environment on `.env` file
```dotenv
GS_OTP_API_KEY=''
GS_OTP_SEND_METHOD=sms
GS_OTP_TEMPLATE_ID=3
```

### Send OTP
```php
$referenceID = LaravelOTP::send($mobile);
```
### Status
```php
$status = LaravelOTP::status($referenceID);
```

### Verify
```php
$verify = LaravelOTP::verify($mobile, $otp);
```

## License

MIT.

[ico-version]: https://img.shields.io/packagist/v/globalsmartotp/laravel-otp.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/globalsmartotp/laravel-otp.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/globalsmartotp/laravel-otp
[link-downloads]: https://packagist.org/packages/globalsmartotp/laravel-otp