PHPackages                             trezrayan/raygan-sms - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. trezrayan/raygan-sms

ActiveLibrary[API Development](/categories/api)

trezrayan/raygan-sms
====================

A simple API extension for send text message By Raygan Sms

01.6k↓50%1PHP

Since Aug 12Pushed 2y ago1 watchersCompare

[ Source](https://github.com/TrezRayanCo/raygan-sms)[ Packagist](https://packagist.org/packages/trezrayan/raygan-sms)[ RSS](/packages/trezrayan-raygan-sms/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (1)Used By (0)

RayganSms
=========

[](#raygansms)

RayganSms API for send text messages

[![Latest Version on Packagist](https://camo.githubusercontent.com/571ee0eee41bfe7ec6f780abd1672ec37334073447d74487bfbf113d6f8999ad/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7472657a2f72617967616e2d736d732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/trez/raygan-sms)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![StyleCI](https://camo.githubusercontent.com/7d16d32d93ce06390f1511150682d00ef23e1e23a23a97e1fba2f4e17d4cc272/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3136343834363639392f736869656c643f6272616e63683d6d6173746572)](https://github.styleci.io/repos/164846699)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/3a358a920afa5f8497f1de5d9b155489f82805afdd196abcb8759560e4d3eafe/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6661726861646d69727a61706f75722f52617967616e536d732f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/farhadmirzapour/RayganSms/?branch=master)[![Build Status](https://camo.githubusercontent.com/5943c27fb06963014afecf01d6f2db25d9a0d798fbc16fca7839e4e0891d2919/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6661726861646d69727a61706f75722f52617967616e536d732f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/farhadmirzapour/RayganSms/build-status/master)[![Code Intelligence Status](https://camo.githubusercontent.com/30e47a84d0eaaf9a6ea3046251d668d6a5d601a213ba2caa936944ed9f92fa5b/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6661726861646d69727a61706f75722f52617967616e536d732f6261646765732f636f64652d696e74656c6c6967656e63652e7376673f623d6d6173746572)](https://scrutinizer-ci.com/code-intelligence)[![Quality Score](https://camo.githubusercontent.com/a6ae1d69f734d926a2a7cdfcacd9c77c1d2acd17cd5e8f472e6cf800198b1a8d/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6661726861646d69727a61706f75722f52617967616e536d732e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/farhadmirzapour/RayganSms)[![Total Downloads](https://camo.githubusercontent.com/9fa1d0e9e1a748f97c1dba776ecf0c324da7c90e8374d09178ae121ebae201d6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7472657a2f72617967616e2d736d732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/trez/raygan-sms)

 این پکیج امکان اتصال [RayganSms API](https://raygansms.com/) به فریم ورک هایی که جهت نصب پکیج ها از [composer](http://farhadnote.ir/articles/2017/10/29/composer.html) و از استاندارد [PSR-4](http://farhadnote.ir/articles/2017/10/20/psr.html) جهت [autoload](http://farhadnote.ir/articles/2017/11/09/composer-autoloading.html#%D8%B1%D9%88%D8%B4-psr-4-based-autoloading) نمودن کلاس ها استفاده می نمایند همانند (Laravel,Yii,symfony) را فراهم می سازد. محتوا
-----

[](#محتوا)

- [نصب و پیکره بندی](#%D9%86%D8%B5%D8%A8-%D9%88-%D9%BE%DB%8C%DA%A9%D8%B1%D9%87-%D8%A8%D9%86%D8%AF%DB%8C)
- [نحوه استفاده](#%D9%86%D8%AD%D9%88%D9%87-%D8%A7%D8%B3%D8%AA%D9%81%D8%A7%D8%AF%D9%87)
- [متدها](#%D9%85%D8%AA%D8%AF%D9%87%D8%A7)
- [Laravel](#Laravel)
    - [پیکره بندی در لاراول](#%D9%BE%DB%8C%DA%A9%D8%B1%D9%87-%D8%A8%D9%86%D8%AF%DB%8C-%D8%AF%D8%B1-%D9%84%D8%A7%D8%B1%D8%A7%D9%88%D9%84)
    - [نحوه استفاده در لاراول](#%D9%86%D8%AD%D9%88%D9%87-%D8%A7%D8%B3%D8%AA%D9%81%D8%A7%D8%AF%D9%87-%D8%AF%D8%B1-%D9%84%D8%A7%D8%B1%D8%A7%D9%88%D9%84)
    - [استفاده در سیستم اعلانات لاراول ](#%D8%A7%D8%B3%D8%AA%D9%81%D8%A7%D8%AF%D9%87-%D8%AF%D8%B1-%D8%B3%DB%8C%D8%B3%D8%AA%D9%85-%D8%A7%D8%B9%D9%84%D8%A7%D9%86%D8%A7%D8%AA-%D9%84%D8%A7%D8%B1%D8%A7%D9%88%D9%84)
- [تولیدکننده](#%D8%AA%D9%88%D9%84%DB%8C%D8%AF%DA%A9%D9%86%D9%86%D8%AF%D9%87)
- [لایسنس](#%D9%84%D8%A7%DB%8C%D8%B3%D9%86%D8%B3)

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

[](#نصب-و-پیکره-بندی)

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

```
composer require trezrayan/raygan-sms
```

نحوه استفاده
------------

[](#نحوه-استفاده)

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

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

### متدها

[](#متدها)

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

[](#1--متد-ارسال-پیامک)

`sendMessage($reciver_number, $text_message)`

 مثال :

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

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

[](#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- بررسی صحت کد دریافتی احراز هویت ارسال شده توسط کاربر

[](#3---بررسی-صحت-کد-دریافتی-احراز-هویت-ارسال-شده-توسط-کاربر)

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

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

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

[](#نحوه-استفاده-در-لاراول)

 هم اکنون می توانید با استفاده از 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](https://laravel.com/docs/5.7/notifications)) لاراول، پکیج [raygan-sms-notification-channel](https://github.com/farhadmirzapour/RaygansmsChannel) را نصب و طبق مستندات مربوطه عمل نمائید.

تولیدکننده
----------

[](#تولیدکننده)

- [Farhad Mirzapour](https://github.com/farhadmirzapour)

لایسنس
------

[](#لایسنس)

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

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity21

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/df55ffea016d55396442365529226aaec717960f19ae65b6000342c875a162aa?d=identicon)[Trez](/maintainers/Trez)

---

Top Contributors

[![TrezRayanCo](https://avatars.githubusercontent.com/u/43716183?v=4)](https://github.com/TrezRayanCo "TrezRayanCo (3 commits)")

### Embed Badge

![Health badge](/badges/trezrayan-raygan-sms/health.svg)

```
[![Health](https://phpackages.com/badges/trezrayan-raygan-sms/health.svg)](https://phpackages.com/packages/trezrayan-raygan-sms)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M453](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
