PHPackages xtwoend/hyperf-otp - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. xtwoend/hyperf-otp ActiveLibrary[Authentication & Authorization](/categories/authentication) xtwoend/hyperf-otp ================== OTP service support TOTP 010PHP Since Apr 13Pushed 5y ago1 watchersCompare [ Source](https://github.com/xtwoend/hyperf-otp)[ Packagist](https://packagist.org/packages/xtwoend/hyperf-otp)[ RSS](/packages/xtwoend-hyperf-otp/feed)WikiDiscussions master Synced 1w ago READMEChangelogDependenciesVersions (1)Used By (0) OTP Validate Package in Hyperf ============================== [](#otp-validate-package-in-hyperf) This package is for easy setup for OTP validation process. No hassle, just plug and play. Following the steps mentioned below and you will be able to get a fully working OTP Validation system. You can use this later for authentication or e-commerce production selling, order confirmation. Installation ------------ [](#installation) ### Install Package [](#install-package) Require this package with composer: ``` composer require xtwoend/hyperf-otp ``` Publish Config -------------- [](#publish-config) Once done, publish the config to your config folder using: ``` php bin/hyperf.php vendor:publish xtwoend/hyperf-otp ``` This command will create a `config/otp.php` file. ### Email Configs [](#email-configs) From the `.env` file the email configs are setup. No other changes required. ### SMS Configs [](#sms-configs) As the SMS Gateways use different methods and also extra headers and params, you may need to update the sms configs in the `otp.php` file. Migrate Database ---------------- [](#migrate-database) Run the following command to create the otps table. ``` php bin/hyperf.php migrate ``` It will create a otps table with the required columns. Environment ----------- [](#environment) Add the following Key-Value pair to the `.env` file in the Laravel application ``` # Basic OTP Configs OTP_SERVICE='enabled' OTP_TABLE_NAME='otps' OTP_TIMEOUT=120 OTP_DIGIT=5 OTP_RESEND_SERVICE='enabled' OTP_MAX_RETRY=2 OTP_MAX_RESEND=1 # Company and Service OTP_SERVICE_NAME= OTP_COMPANY_NAME= # OTP via Email / SMS OTP_SEND_BY_EMAIL=1 OTP_SEND_BY_SMS=1 # Email Configurations OTP_EMAIL_FROM= OTP_EMAIL_FROM_NAME= OTP_EMAIL_SUBJECT= # SMS Configurations OTP_SMSC_URL='https://sms' OTP_SMSC_METHOD= OTP_COUNTRY_CODE= OTP_SMSC_OVER_JSON= OTP_SMSC_PARAM_TO_NAME= OTP_SMSC_PARAM_MSG_NAME= OTP_SMSC_USER= OTP_SMSC_PASS= ``` Definitions ----------- [](#definitions) Definition of the features in config are: - service : enable/disable OTP Service - timeout: timeout for OTP - digit: OTP Digit - resend-service: enable/disable resend Service - max-retry: max retry for a single request - max-resend: max resend for a single request - service-name: for which the service is used - company-name: for which company - send-by: there are 2 ways to share otp (Email/SMS) - email: this key specifies the required information for email (e.g. from, name, subject etc.) - sms: configure with SMS gateway to send SMS. (Universal Configurator) OTP Request Templates --------------------- [](#otp-request-templates) Once the template files are published, open `template/` Sample Controller ----------------- [](#sample-controller) Below is a sample for calling the OTP Validator in OtpController. ``` namespace App\Controllers; use Xtwoend\HyperfOtp\Object\OtpRequestObject; use Xtwoend\HyperfOtp\OtpValidator; use Xtwoend\HyperfOtp\Object\OtpValidateRequestObject; class OtpController extends Controller { /** * @return array */ public function requestForOtp() { return OtpValidator::requestOtp( new OtpRequestObject('1432', 'buy-shirt', '01711084714', 'ferdousul.haque@gmail.com') ); } /** * @param Request $request * @return array */ public function validateOtp(RequestInterface $request) { $uniqId = $request->input('uniqueId'); $otp = $request->input('otp'); return OtpValidator::validateOtp( new OtpValidateRequestObject($uniqId,$otp) ); } /** * @param Request $request * @return array */ public function resendOtp(RequestInterface $request) { $uniqueId = $request->input('uniqueId'); return OtpValidator::resendOtp($uniqueId); } } ``` Add the following to the `routes/web.php` file. ``` Route::get('/test/otp-request', 'OtpController@requestForOtp'); Route::get('/test/otp-validate', 'OtpController@validateOtp'); Route::get('/test/otp-resend', 'OtpController@resendOtp'); ``` Response/Error Descriptions --------------------------- [](#responseerror-descriptions) The below table describes the error codes generated in the response and their corresponding meanings. ``` { "code": 201, "message": "OTP Sent to the recipient", "requestId": 1432, "type": "buy-shirt" } ``` #### Request OTP Response Codes [](#request-otp-response-codes) CodeMeanings201Successfully Generated OTP and shared.400Bad request.501Resend Service Disabled.503Service Unavailable.#### OTP Validate Response Codes [](#otp-validate-response-codes) CodeMeanings200Correct OTP.400Invalid OTP.404OTP Expired/Not Found.413Max Retry Exceeded.License ------- [](#license) MIT Special Thanks -------------- [](#special-thanks) - [Nahid Bin Azhar](https://github.com/nahid) For the Feedback. Support ------- [](#support) - For any bugs, please help to create an issue. - For any problem installing or configurations, feel free to knock me. Featured Article ---------------- [](#featured-article) - [How to create a laravel OTP/Security code verification for e-commerce website](https://medium.com/@ferdousul.haque/how-to-create-a-laravel-otp-security-code-verification-for-e-commerce-website-55de8161cfb8) Example SMS Gateways Configuration ---------------------------------- [](#example-sms-gateways-configuration) ### [Muthofun](https://www.muthofun.com/) [](#muthofun) If you are trying to integrate one of most popular SMS gateway of Bangladesh, muthofun is a popular Bulk SMS Gateway in our country. Here is a sample configuration for the Muthofun SMS Gateway ``` 'smsc' => [ 'url' => env('OTP_SMSC_URL'), 'method' => env('OTP_SMSC_METHOD', 'GET'), 'add_code' => env('OTP_COUNTRY_CODE',null), 'json' => env('OTP_SMSC_OVER_JSON',1), 'headers' => [], 'params' => [ 'send_to_param_name' => env('OTP_SMSC_PARAM_TO_NAME','number'), 'msg_param_name' => env('OTP_SMSC_PARAM_MSG_NAME','msg'), 'others' => [ 'user' => env('OTP_SMSC_USER'), 'password' => env('OTP_SMSC_PASS'), 'unicode' => 1 ], ] ]; ``` .env file will be as the following ``` OTP_SMSC_URL='http://clients.muthofun.com:8901/esmsgw/sendsms.jsp?' OTP_SMSC_METHOD='GET' OTP_COUNTRY_CODE='88' OTP_SMSC_OVER_JSON=0 OTP_SMSC_PARAM_TO_NAME='mobiles' OTP_SMSC_PARAM_MSG_NAME='sms' OTP_SMSC_USER='YourUserName' OTP_SMSC_PASS='YourPassWord' ``` ### [Infobip](https://www.infobip.com/) [](#infobip) Example for integrating with the infobip SMS platform, renowned SMS Gateway. using GET method ``` 'smsc' => [ 'url' => env('OTP_SMSC_URL'), 'method' => env('OTP_SMSC_METHOD', 'GET'), 'add_code' => env('OTP_COUNTRY_CODE',null), 'json' => env('OTP_SMSC_OVER_JSON',1), 'headers' => [], 'params' => [ 'send_to_param_name' => env('OTP_SMSC_PARAM_TO_NAME','number'), 'msg_param_name' => env('OTP_SMSC_PARAM_MSG_NAME','msg'), 'others' => [ 'username' => env('OTP_SMSC_USER'), 'password' => env('OTP_SMSC_PASS'), 'from' => 'InfoSMS', 'flash' => true ], ] ]; ``` .env file will be as the following ``` OTP_SMSC_URL='https://{baseUrl}/sms/1/text/query?' OTP_SMSC_METHOD='GET' OTP_COUNTRY_CODE='88' OTP_SMSC_OVER_JSON=0 OTP_SMSC_PARAM_TO_NAME='to' OTP_SMSC_PARAM_MSG_NAME='text' OTP_SMSC_USER='YourUserName' OTP_SMSC_PASS='YourPassWord' ``` ### [msg91](https://msg91.com) [](#msg91) Sample for integrating with the msg91 SMS gateway. using GET method ``` 'smsc' => [ 'url' => env('OTP_SMSC_URL'), 'method' => env('OTP_SMSC_METHOD', 'GET'), 'add_code' => env('OTP_COUNTRY_CODE',null), 'json' => env('OTP_SMSC_OVER_JSON',1), 'headers' => [], 'params' => [ 'send_to_param_name' => env('OTP_SMSC_PARAM_TO_NAME','number'), 'msg_param_name' => env('OTP_SMSC_PARAM_MSG_NAME','msg'), 'others' => [ 'authkey' => 'YourAuthKey', 'sender' => 'YourSenderId', 'route' => '1', 'country' => '88', ], ], 'wrapper' => 'sms', ]; ``` .env file will be as the following ``` OTP_SMSC_URL='https://control.msg91.com/api/v2/sendsms?' OTP_SMSC_METHOD='POST' OTP_COUNTRY_CODE='88' OTP_SMSC_OVER_JSON=1 OTP_SMSC_PARAM_TO_NAME='to' OTP_SMSC_PARAM_MSG_NAME='text' OTP_SMSC_USER='YourUserName' OTP_SMSC_PASS='YourPassWord' ``` ### Health Score 17 — LowBetter than 6% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity30 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/707e862eb8fddef4791639520cae4efdc10855859dcf3aa74c1bafa46c5bb575?d=identicon)[xtwoend](/maintainers/xtwoend) --- Top Contributors [![xtwoend](https://avatars.githubusercontent.com/u/1768785?v=4)](https://github.com/xtwoend "xtwoend (2 commits)") ### Embed Badge ![Health badge](/badges/xtwoend-hyperf-otp/health.svg) ``` [![Health](https://phpackages.com/badges/xtwoend-hyperf-otp/health.svg)](https://phpackages.com/packages/xtwoend-hyperf-otp) ``` ### Alternatives [namshi/jose JSON Object Signing and Encryption library for PHP. 1.8k99.6M101](/packages/namshi-jose)[league/oauth1-client OAuth 1.0 Client Library 99698.8M106](/packages/league-oauth1-client)[bezhansalleh/filament-shield Filament support for `spatie/laravel-permission`. 2.8k2.9M88](/packages/bezhansalleh-filament-shield)[gesdinet/jwt-refresh-token-bundle Implements a refresh token system over Json Web Tokens in Symfony 70516.4M35](/packages/gesdinet-jwt-refresh-token-bundle)[league/oauth2-google Google OAuth 2.0 Client Provider for The PHP League OAuth2-Client 41721.2M118](/packages/league-oauth2-google)[illuminate/auth The Illuminate Auth package. 9327.3M1.0k](/packages/illuminate-auth) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)