trez/raygan-sms

A simple API extension for send text message By Raygan Sms

2.0.1 2019-06-19 18:59 UTC

README

RayganSms API for send text messages

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

این پکیج امکان اتصال RayganSms API به فریم ورک هایی که جهت نصب پکیج ها از composer و از استاندارد PSR-4 جهت autoload نمودن کلاس ها استفاده می نمایند همانند (Laravel,Yii,symfony) را فراهم می سازد.

محتوا

نصب و پیکره بندی

با استفاده از composer قادر به نصب این سرویس می باشید:

composer require trez/raygan-sms

نحوه استفاده

مطابق کد زیر تنظیمات شناسه، رمزعبور و شماره تماس ارسال کننده را وارد نمائید:

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

متدها

1- متد ارسال پیامک

sendMessage($reciver_number, $text_message)

مثال :
echo $sms->sendMessage('0936*******','Test Message');

2- متد ارسال کد احراز هویت 2FA یا (Two Factor Authentication)

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);

3- بررسی صحت کد دریافتی احراز هویت ارسال شده توسط کاربر

چنانچه کد فعال سازی بصورت اتوماتیک به کاربر ارسال شده باشد، جهت صحت کد دریافتی از سوی کاربر می توان از این متد استفاده نمود.

checkAuthCode($reciver_number, $reciver_code)

مثال :
$result = $sms->checkAuthCode('0936*******','922387');
if($result){
    ///
}else{
    ///
}

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
...

نحوه استفاده در لاراول

هم اکنون می توانید با استفاده از 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);
   ...

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

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

تولیدکننده

لایسنس

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