README

RayganSms API for send text messages

این پکیج امکان اتصال RayganSms API را به فریم ورک (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 و aliase زیر را به فایل 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{
    ///
}

استفاده در سیستم اعلانات لاراول

جهت استفاده از سیستم اعلانات (Notefications) لاراول، پکیج raygan-sms-notification-channel را نصب و طبق مستندات مربوطه عمل نمائید.

تولیدکننده

Farhad Mirzapour

لایسنس

لایسنس این پکیج (MIT) می باشد . جهت اطلاعات در مورد این لایسنس به License File مراجعه نمایید.

trez / raygan-sms

Maintainers

Details