trez-sms/new-raygan-sms

Raygan Sms 提供的简单 API 扩展,用于发送短信

dev-main 2024-05-11 09:58 UTC

This package is auto-updated.

Last update: 2024-09-11 10:48:16 UTC


README

RayganSms API 用于发送短信

Latest Version on Packagist Software License StyleCI Scrutinizer Code Quality Build Status Code Intelligence Status Quality Score Total Downloads

本软件包允许将 RayganSms API 连接到使用 composerPSR-4 标准进行类自动加载的框架(如 Laravel, Yii, symfony)。

内容

安装和配置

使用 composer 可以安装此服务

composer require trez/raygan-sms

使用方法

请按照以下代码输入发送者的标识、密码和电话号码

$user_name = '*******';
$password = '*******';
$phone_number = '*******';;
$sms = new \Trez\RayganSms\Sms($user_name,$password,$phone_number);

方法

32- 发送短信的方法

sendMessage($reciver_number, $text_message)

示例
echo $sms->sendMessage('0936*******','Test Message');

35- 发送 2FA 或双因素认证码的方法

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

注意:如果 autoGenerateCode 参数设置为 true,系统会自动发送一个激活码给用户;如果设置为 false,则发送包含所需代码的文本。示例
echo $sms->sendAuthCode('0936*******');
...
echo $sms->sendAuthCode('0936*******', 'Send From ...');
...
echo $sms->sendAuthCode('0936*******', 'Your Auth Code: 12346', false);

38- 验证用户收到的认证码的有效性

如果激活码是自动发送的,可以使用此方法验证用户收到的认证码的有效性。

checkAuthCode($reciver_number, $reciver_code)

示例
$result = $sms->checkAuthCode('0936*******','922387');
if($result){
    ///
}else{
    ///
}

Laravel

在 Laravel 中的配置

安装软件包后,请根据以下内容编辑 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 和 aliase 添加到 config/app.php 文件中
// config/app.php
...
Trez\RayganSms\RayganSmsServiceProvider::class,
...
'RayganSms' => Trez\RayganSms\Facades\RayganSms::class
...

在 Laravel 中的使用方法

现在,您可以使用 Facade 通过 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);
   ...

在 Laravel 的系统通知中使用

为了使用 Laravel 的通知系统,请安装 raygan-sms-notification-channel 包,并按照相关文档进行操作。

制造商

许可证

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