README

RayganSms API 用于发送短信

此软件包允许将 RayganSms API 连接到 (Laravel) 框架。

内容

安装和配置
方法
在 Laravel 系统通知中使用
制作人
许可证

安装和配置

您可以使用 composer 安装此服务

composer require trez/raygan-sms

安装软件包后，请根据以下内容编辑 config/services.php 和 env. 文件

// .env
...
RAYGANSMS_USERNAME=*******
RAYGANSMS_PASSWORD=*******
RAYGANSMS_PHONE_NUMBER=*******
...

// config/services.php
...
    'raygansms' => [
        'user_name' => env('RAYGANSMS_USERNAME'),
        'password' => env('RAYGANSMS_PASSWORD'),
        'phone_number' => env('RAYGANSMS_PHONE_NUMBER'),
    ],
...

如果您使用的是低于 5.5 的版本，请将 ServiceProvider 和 alias 添加到 config/app.php 文件中

// config/app.php
...
Trez\RayganSms\RayganSmsServiceProvider::class,
...
'RayganSms' => Trez\RayganSms\Facades\RayganSms::class
...

现在，您可以使用 Facade 访问此软件包 (RayganSms) 中的方法

use Trez\RayganSms\Facades\RayganSms;
   ...

echo  RayganSms::sendMessage('0936*******','Test Message');
   ...   
   
echo  RayganSms::sendAuthCode('0936*******','Welcome ...');
   ...
   
$result = RayganSms::checkAuthCode('0936*******','922387');
if($result){
   ///
}else{
  ///
}
   ...   
   
echo  RayganSms::sendAuthCode('0936*******', 'Your Auth Code: 123456', false);
   ...

方法

1- 发送短信方法

sendMessage($reciver_number, $text_message)

示例

echo RayganSms::sendMessage('0936*******','Test Message');

2- 发送 2FA 或 (Two Factor Authentication) 验证码方法

sendAuthCode($reciver_number, $text_message = null, $autoGenerateCode = true)

注意：如果 autoGenerateCode$ 参数的值为 true，则系统会自动向用户发送一个激活码；如果为 false，则发送包含指定代码的文本。示例

echo RayganSms::sendAuthCode('0936*******');
...
echo RayganSms::sendAuthCode('0936*******', 'Send From ...');
...
echo RayganSms::sendAuthCode('0936*******', 'Your Auth Code: 12346', false);

3- 验证用户发送的验证码

如果激活码是自动发送的，可以使用此方法来验证用户接收到的代码。

checkAuthCode($reciver_number, $reciver_code)

示例

$result = RayganSms::checkAuthCode('0936*******','922387');
if($result){
    ///
}else{
    ///
}

在 Laravel 系统通知中使用

要使用 Laravel 的系统通知 (Notifications)，请安装 raygan-sms-notification-channel 软件包，并根据相关文档进行操作。

制作人

Farhad Mirzapour

许可证

此软件包的许可证为 MIT。有关此许可证的更多信息，请参阅许可证文件。

trez / raygan-sms

维护者

详细信息