hizbul / laravel-sms-verification
在laravel中发送短信验证手机号码。
v1.2
2020-04-24 03:59 UTC
This package is not auto-updated.
Last update: 2024-09-21 00:09:16 UTC
README
此软件包包含一组用于通过短信进行手机号码验证的简单端点。
短信通过Onnorokom.com API执行,实际上这段代码旨在演示使用Onnorokom.com API的实际用例。所有可用的Onnorokom.com API都在https://panel.onnorokomsms.com/Content/OnnoRokomSmsWebSeviceAndApiDocumentation.pdf中定义。
服务器使用PHP和Laravel框架编写。
安装
运行以下命令
composer require hizbul/laravel-sms-verification
安装此库后,您需要注册服务提供者。打开config/app.php
并找到providers
键。
'providers' => [
...
\Hizbul\SmsVerification\SmsVerificationProvider::class,
...
]
运行命令
php artisan vendor:publish --provider="Hizbul\SmsVerification\SmsVerificationProvider" --tag=config
将SMS验证端点添加到您的路由文件中
\Hizbul\SmsVerification\SmsVerificationProvider::registerRoutes($router);
SMS验证的过程如下
- 使用POST
/sms-verification
向手机设备发送验证码 - 使用GET
/sms-verification/{code}/{mobilePhoneNumber}
验证验证码
例如,如果应用程序想要向手机号码855-123-8765发送授权码
- 向URL https://api.example.com/sms-verification发送POST
/sms-verification
API,JSON正文为{"phone_number" : "+88019194560**"}
- 如果发送成功,API返回
{"success":true,"description":"OK","expires_at": 1495120612}
。其中expires_at
是代码的实际过期时间。 - 手机将收到一个六位数的代码(例如:123456)
- 为了验证代码,向
https://api.example.com/sms-verification/123456/+88019194560**
发送GET /sms-verification API - API返回
- 成功时:
{"success":true,"description":"OK","expires_at": 1495120612}
- 失败时:
{"success":false,"description":"Wrong code"}
- 成功时:
错误
如果在SMS验证过程中抛出异常,输出将包含字段error
。
1XX
- 代码验证错误2XX
- 配置不正确3XX
- 输入格式验证失败5XX
- 代码生成错误4XX
- 代码发送错误999
- 与SMS验证库无关的任何其他服务器错误
注意
- 发送的授权码仅在10分钟内有效
- 代码只能验证一次。第一次成功后,它将被无效化
- 如果您发现任何缓存问题,请使用除
files
之外的任何缓存驱动程序。