PHPackages                             amirrajabzadeh/farapayamak-laravel - 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. amirrajabzadeh/farapayamak-laravel

ActiveLibrary[API Development](/categories/api)

amirrajabzadeh/farapayamak-laravel
==================================

Official Farapayamak SOAP package for Laravel - Full 8 web services with OTP support

v2.1.1(1mo ago)010MITPHPPHP ^7.4|^8.0|^8.1|^8.2|^8.3|^8.4

Since Apr 15Pushed 1mo agoCompare

[ Source](https://github.com/amirrajabzadeh/farapayamak-laravel)[ Packagist](https://packagist.org/packages/amirrajabzadeh/farapayamak-laravel)[ RSS](/packages/amirrajabzadeh-farapayamak-laravel/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (4)Dependencies (1)Versions (10)Used By (0)

فراپیامک لاراول - Farapayamak Laravel

=======================================

[](#فراپیامک-لاراول---farapayamak-laravel)

> پکیج رسمی و کامل وب سرویس فراپیامک (ملی پیامک) برای لاراول

[![Latest Version](https://camo.githubusercontent.com/b46547e2dc812961065fece02bbc149a819fd759b86f2a69f79e28297c8895d3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616d697272616a61627a616465682f66617261706179616d616b2d6c61726176656c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/amirrajabzadeh/farapayamak-laravel)[![Total Downloads](https://camo.githubusercontent.com/235aefe0d9dcd3400809f893bc6e85d0b11ffbc3829c55ea9dffa17eba02cb96/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f616d697272616a61627a616465682f66617261706179616d616b2d6c61726176656c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/amirrajabzadeh/farapayamak-laravel)[![PHP Version](https://camo.githubusercontent.com/47f8d2c7cb2fc1fee982145fe79ad242cd127cdb3025b0ad9e6bcaf460a92fb4/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344372e342d3838393242462e7376673f7374796c653d666c61742d737175617265)](https://php.net)[![Laravel Version](https://camo.githubusercontent.com/1d345d1e252becc5111aac1295a9b3f41d930c8f177fae5a6cc531f544d02269/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c61726176656c2d382e78253230253743253230392e7825323025374325323031302e7825323025374325323031312e7825323025374325323031322e782d4646324432302e7376673f7374796c653d666c61742d737175617265)](https://laravel.com)[![License](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](LICENSE)

---

**نویسنده:** امیر رجب زاده
**ایمیل:**
**وبسایت:**
**گیت‌هاب:** [amirrajabzadeh/farapayamak-laravel](https://github.com/amirrajabzadeh/farapayamak-laravel)

---

✨ ویژگی‌ها

------------

[](#-ویژگی‌ها)

- ✅ پشتیبانی از تمام **8 وب سرویس** فراپیامک
- ✅ متد **SendOtp** برای ارسال کد تأیید یکبارمصرف
- ✅ **اضافه شدن خودکار "لغو11"** به انتهای پیام (الزامی برای وب سرویس)
- ✅ ارسال پیامک **ساده**، **پیشرفته**، **چندتایی** و **زماندار**
- ✅ مدیریت کامل **دفترچه تلفن** و **گروه‌ها**
- ✅ دریافت پیامک‌های **رسیده** از صندوق ورودی
- ✅ دریافت **اعتبار** و **وضعیت تحویل** پیامک
- ✅ **خروجی آرایه استاندارد** با ساختار یکسان برای همه متدها
- ✅ **بدون نیاز به دیتابیس**
- ✅ **کامنت‌گذاری کامل به فارسی**
- ✅ پشتیبانی از **لاراول 8 تا 12**
- ✅ پشتیبانی از **PHP 7.4 تا 8.4**

---

📋 نیازمندی‌ها

---------------

[](#-نیازمندی‌ها)

- **PHP** نسخه 7.4 یا بالاتر (تا 8.4)
- **لاراول** نسخه 8.x، 9.x، 10.x، 11.x یا 12.x
- **افزونه‌های PHP:**
    - `ext-soap` (برای ارتباط با وب سرویس SOAP)
    - `ext-json` (برای پردازش JSON)

> **نکته:** برای فعال کردن افزونه SOAP در فایل `php.ini`، خط `extension=soap` را از حالت کامنت خارج کنید.

---

📦 نصب

-------

[](#-نصب)

```
composer require amirrajabzadeh/farapayamak-laravel
```

---

⚙️ تنظیمات

------------

[](#️-تنظیمات)

### 1. افزودن متغیرهای محیطی در فایل `.env`

[](#1-افزودن-متغیرهای-محیطی-در-فایل-env)

```
FARAPAYAMAK_USERNAME=نام_کاربری_شما
FARAPAYAMAK_PASSWORD=رمز_عبور_شما
FARAPAYAMAK_DEBUG=false
```

### 2. انتشار فایل کانفیگ (اختیاری)

[](#2-انتشار-فایل-کانفیگ-اختیاری)

```
php artisan vendor:publish --tag=farapayamak-config
```

فایل کانفیگ در `config/farapayamak.php` قرار می‌گیرد.

---

🚀 راهنمای استفاده

-------------------

[](#-راهنمای-استفاده)

### ساختار خروجی استاندارد

[](#ساختار-خروجی-استاندارد)

تمامی متدهای این پکیج یک **آرایه استاندارد** با ساختار زیر برمی‌گردانند:

```
[
    'success' => true,      // boolean: موفقیت یا خطا
    'message' => '...',     // string: پیام توضیحی فارسی
    'data' => mixed,        // mixed: داده اصلی (RecId, Credit, ...)
    'code' => null,         // int|null: کد خطا (در صورت موفقیت null)
    'raw' => mixed          // mixed: پاسخ خام وب سرویس (برای دیباگ)
]
```

### 1. ارسال پیامک ساده

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

```