PHPackages                             melipayamak/php - 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. melipayamak/php

ActiveLibrary[API Development](/categories/api)

melipayamak/php
===============

A PHP wrapper for melipayamak's web services

1.0.0(6y ago)3294.4k↓25.3%7[6 issues](https://github.com/Melipayamak/melipayamak-php/issues)5MITPHPPHP >=5.4.0

Since Mar 13Pushed 2y ago2 watchersCompare

[ Source](https://github.com/Melipayamak/melipayamak-php)[ Packagist](https://packagist.org/packages/melipayamak/php)[ Docs](http://github.com/Melipayamak/melipayamak-php)[ RSS](/packages/melipayamak-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)DependenciesVersions (4)Used By (5)

Melipayamak PHP
===============

[](#melipayamak-php)

### معرفی وب سرویس ملی پیامک

[](#معرفی-وب-سرویس-ملی-پیامک)

ملی پیامک یک وب سرویس کامل برای ارسال و دریافت پیامک و پیامک صوتی و مدیریت کامل خدمات دیگر است که براحتی میتوانید از آن استفاده کنید.

---

### نصب

[](#نصب)

قبل از نصب نیاز به ثبت نام در سایت ملی پیامک دارید.

[**ثبت نام به همراه دریافت 200 پیامک هدیه جهت تست وبسرویس**](http://www.melipayamak.com/)

پس ازثبت نام برای نصب از راههای زیر میتوانید اقدام کنید.

```
composer require melipayamak/php:1.0.0
```

یا از طریق اضافه کردن خط زیر به فایل composer.json

```
"melipayamak/php": "1.0.0"
```

و سپس اجرای دستور

```
composer update

```

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

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

نمونه کد برای ارسال پیامک

```
require __DIR__ . '/vendor/autoload.php';
use Melipayamak\MelipayamakApi;
try{
    $username = 'username';
    $password = 'password';
    $api = new MelipayamakApi($username,$password);
    $sms = $api->sms();
    $to = '09123456789';
    $from = '5000...';
    $text = 'تست وب سرویس ملی پیامک';
    $response = $sms->send($to,$from,$text);
    $json = json_decode($response);
    echo $json->Value; //RecId or Error Number
}catch(Exception $e){
    echo $e->getMessage();
}
```

از آنجا که وب سرویس ملی پیامک تنها محدود به ارسال پیامک نیست شما از طریق زیر میتوانید به وب سرویس ها دسترسی کامل داشته باشید:

```
// وب سرویس پیامک
$smsRest = $api->sms();
$smsSoap = $api->sms('soap');
// وب سرویس تیکت پشتیبانی
$ticket = $api->ticket();
// وب سرویس برای مدیریت کامل  ارسال انبوه پیامک
$branch = $api->branch();
//وب سرویس کاربران
$users = $api->users();
//وب سرویس دفترچه تلفن
$contacts = $api->contacts()
```

##### حالت آسنکرون

[](#حالت-آسنکرون)

شما میتوانید از وب سرویس ملی پیامک در حالت آسنکرون هم استفاده کنید. آماده سازی آسنکرون در PHP به صورت زیر است. توجه کنید که دستورات آسنکرون به شرط فراخوانی متد `execute` (بطور موازی) انجام می شوند.

```
// وب سرویس پیامک
$smsRestAsync = $api->sms('async');
$smsSoapAsync = $api->sms('soap', 'async');
// وب سرویس تیکت پشتیبانی
$ticket = $api->ticket('async');
// وب سرویس برای مدیریت کامل  ارسال انبوه پیامک
$branch = $api->branch('async');
//وب سرویس کاربران
$users = $api->users('async');
//وب سرویس دفترچه تلفن
$contacts = $api->contacts('async');
```

#### تفاوت های وب سرویس پیامک rest و soap

[](#تفاوت-های-وب-سرویس-پیامک-rest-و-soap)

از آنجا که ملی پیامک وب سرویس کاملی رو در اختیار توسعه دهندگان میگزارد برای راحتی کار با وب سرویس پیامک علاوه بر وب سرویس اصلی soap وب سرویس rest رو هم در اختیار توسعه دهندگان گزاشته شده تا راحتتر بتوانند با وب سرویس کار کنند. تفاوت اصلی این دو در تعداد متد هاییست که میتوانید با آن کار کنید. برای کار های پایه میتوان از وب سرویس rest استفاده کرد برای دسترسی بیشتر و استفاده پیشرفته تر نیز باید از وب سرویس باید از وب سرویس soap استفاده کرد. جهت مطالعه بیشتر وب سرویس ها به قسمت وب سرویس پنل خود مراجعه کنید.

---

### اطلاعات بیشتر

[](#اطلاعات-بیشتر)

برای مطالعه بیشتر و دریافت راهنمای وب سرویس ها و آشنایی با پارامتر های ورودی و خروجی وب سرویس به صفحه معرفی [وب سرویس ملی پیامک](https://github.com/Melipayamak/Webservices)مراجعه نمایید .

---

### وب سرویس پیامک

[](#وب-سرویس-پیامک)

متد های وب سرویس:

#### ارسال

[](#ارسال)

```
$smsRest->send($to,$from,$text,$isFlash);
$smsSoap->send($to,$from,$text,$isFlash);
```

#### درج لیست ویژه سیاه

[](#درج-لیست-ویژه-سیاه)

```
$smsSoap->addblacklist($title);
```

#### درج پترن یا الگو

[](#درج-پترن-یا-الگو)

```
$smsSoap->sharedServiceBodyAdd($title,$body,$blackListId);
```

#### مشاهده پترن‌های درج شده

[](#مشاهده-پترن‌های-درج-شده)

```
$smsSoap->getSharedServiceBody();
```

#### ارسال از طریق الگو (خط خدماتی اشتراکی)

[](#ارسال-از-طریق-الگو-خط-خدماتی-اشتراکی)

```
$smsRest->sendByBaseNumber($text,$to,$bodyId);
$smsSoap->sendByBaseNumber($text,$to,$bodyId);
```

- در وب سرویس soap به جای ارسال یک شماره آرایه ای از شماره ها نیز قابل قبول است

#### دریافت وضعیت ارسال

[](#دریافت-وضعیت-ارسال)

```
$smsRest->isDelivered($recId);
$smsSoap->isDelivered($recId);
```

- به در وب سرویس soap به جای تک آیدی میتوان آرایه نیز ارسال کرد.

#### لیست پیامک ها

[](#لیست-پیامک-ها)

```
$smsRest->getMessages($location,$index,$count,$from);
$smsSoap->getMessages($location,$index,$count,$from);
$smsSoap->getMessagesStr($location,$index,$count,$from);
// جهت دریافت به صورت رشته ای
$smsSoap->getMessagesByDate($location,$index,$count,$from,$dateFrom,$dateTo);
//جهت دریافت بر اساس تاریخ
$smsSoap->getUsersMessagesByDate($location,$index,$count,$from,$dateFrom,$dateTo);
// جهت دریافت پیام های کاربران بر اساس تاریخ
```

#### موجودی

[](#موجودی)

```
$smsRest->getCredit();
$smsSoap->getCredit();
```

#### تعرفه پایه / دریافت قیمت قبل از ارسال

[](#تعرفه-پایه--دریافت-قیمت-قبل-از-ارسال)

```
$smsRest->getBasePrice();
$smsSoap->getPrice($irancellCount,$mtnCount,$from,$text);
```

#### لیست شماره اختصاصی

[](#لیست-شماره-اختصاصی)

```
$smsRest->getNumbers();
```

#### بررسی تعداد پیامک های دریافتی

[](#بررسی-تعداد-پیامک-های-دریافتی)

```
$smsSoap->getInboxCount($isRead);
//پیش فرض خوانده نشده
```

#### ارسال پیامک پیشرفته

[](#ارسال-پیامک-پیشرفته)

```
$smsSoap->send2($to,$from,$text,$isflash,$udh);
```

#### مشاهده مشخصات پیام

[](#مشاهده-مشخصات-پیام)

```
$smsSoap->getMessagesReceptions($msgId,$fromRows);
```

#### حذف پیام دریافتی

[](#حذف-پیام-دریافتی)

```
$smsSoap->remove($msgIds);
```

#### ارسال زماندار

[](#ارسال-زماندار)

```
$smsSoap->sendSchedule($to,$from,$text,$isflash,$scheduleDateTime,$period);
```

#### ارسال زماندار متناظر

[](#ارسال-زماندار-متناظر)

```
$smsSoap->sendMultipleSchedule($to,$from,$text,$isflash,$scheduleDateTime,$period);
```

#### ارسال سررسید

[](#ارسال-سررسید)

```
$smsSoap->addUsance($to,$from,$text,$isflash,$scheduleStartDateTime,$repeatAfterDays,$scheduleEndDateTime);
```

#### مشاهده وضعیت ارسال زماندار

[](#مشاهده-وضعیت-ارسال-زماندار)

```
$smsSoap->getScheduleStatus($schId);
```

#### حذف پیامک زماندار

[](#حذف-پیامک-زماندار)

```
$smsSoap->removeSchedule($schId);
```

### وب سرویس پیامک صوتی

[](#وب-سرویس-پیامک-صوتی)

#### ارسال پیامک همراه با تماس صوتی

[](#ارسال-پیامک-همراه-با-تماس-صوتی)

```
$smsSoap->sendWithSpeech($to,$from,$text,$speech);
```

#### ارسال پیامک همراه با تماس صوتی به صورت زمانبندی

[](#ارسال-پیامک-همراه-با-تماس-صوتی-به-صورت-زمانبندی)

```
$smsSoap->sendWithSpeechSchduleDate($to,$from,$text,$speech,$scheduleDate);
```

#### دریافت وضعیت پیامک همراه با تماس صوتی

[](#دریافت-وضعیت-پیامک-همراه-با-تماس-صوتی)

```
$smsSoap->getSendWithSpeech($recId);
```

#### تماس انبوه زماندار

[](#تماس-انبوه-زماندار)

```
$smsSoap->SendBulkSpeechText($title, $body, $receivers, $DateToSend, $repeatCount);
```

#### تماس انبوه زماندار با انتخاب فایل

[](#تماس-انبوه-زماندار-با-انتخاب-فایل)

```
$smsSoap->SendBulkVoiceSMS($title, $voiceFileId, $receivers, $DateToSend, $repeatCount);
```

#### آپلود فایل صوتی

[](#آپلود-فایل-صوتی)

```
$smsSoap->UploadVoiceFile($title, $base64StringFile);
```

### وب سرویس ارسال انبوه/منطقه ای

[](#وب-سرویس-ارسال-انبوهمنطقه-ای)

#### دریافت شناسه شاخه های بانک شماره

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

```
$branch->get($owner);
```

#### اضافه کردن یک بانک شماره جدید

[](#اضافه-کردن-یک-بانک-شماره-جدید)

```
$branch->add($branchName,$owner);
```

#### اضافه کردن شماره به بانک

[](#اضافه-کردن-شماره-به-بانک)

```
$branch->addNumber($mobileNumbers,$branchId);
```

#### حذف یک بانک

[](#حذف-یک-بانک)

```
$branch->remove($branchId);
```

#### ارسال انبوه از طریق بانک

[](#ارسال-انبوه-از-طریق-بانک)

```
$branch->sendBulk($from,$title,$message,$branch,$DateToSend,$requestCount,$bulkType,$rowFrom,$rangeFrom,$rangeTo);
$branch->sendBulk2($from,$title,$message,$branch,$DateToSend,$requestCount,$bulkType,$rowFrom,$rangeFrom,$rangeTo);
```

#### تعداد شماره های موجود

[](#تعداد-شماره-های-موجود)

```
$branch->getBulkCount($branch,$rangeFrom,$rangeTo);
```

#### گزارش گیری از ارسال انبوه

[](#گزارش-گیری-از-ارسال-انبوه)

```
$branch->getBulkReceptions($bulkId,$fromRows);
```

#### تعیین وضعیت ارسال

[](#تعیین-وضعیت-ارسال)

```
$branch->getBulkStatus($bulkId);
```

#### تعداد ارسال های امروز

[](#تعداد-ارسال-های-امروز)

```
$branch->getTodaySent();
```

#### تعداد ارسال های کل

[](#تعداد-ارسال-های-کل)

```
$branch->getTotalSent();
```

#### حذف ارسال منطقه ای

[](#حذف-ارسال-منطقه-ای)

```
$branch->removeBulk($id);
```

#### ارسال متناظر

[](#ارسال-متناظر)

```
$branch->sendMultipleSms($to,$from,$text,$isflash,$udh);
```

#### نمایش دهنده وضعیت گزارش گیری

[](#نمایش-دهنده-وضعیت-گزارش-گیری)

```
$branch->updateBulkDelivery($bulkId);
```

### وب سرویس تیکت

[](#وب-سرویس-تیکت)

#### ثبت تیکت جدید

[](#ثبت-تیکت-جدید)

```
$ticket->add($title,$content,$aletWithSms);
```

#### جستجو و دریافت تیکت ها

[](#جستجو-و-دریافت-تیکت-ها)

```
$ticket->getReceived($ticketOwner,$ticketType,$keyword);
```

#### دریافت تعداد تیکت های کاربران

[](#دریافت-تعداد-تیکت-های-کاربران)

```
$ticket->getReceivedCount($ticketType);
```

#### دریافت تیکت های ارسال شده

[](#دریافت-تیکت-های-ارسال-شده)

```
$ticket->getSent($ticketOwner,$ticketType,$keyword);
```

#### دریافت تعداد تیکت های ارسال شده

[](#دریافت-تعداد-تیکت-های-ارسال-شده)

```
$ticket->getSentCount($ticketType);
```

#### پاسخگویی به تیکت

[](#پاسخگویی-به-تیکت)

```
$ticket->response($ticketId,$type,$content,$alertWithSms);
```

### وب سرویس دفترچه تلفن

[](#وب-سرویس-دفترچه-تلفن)

#### اضافه کردن گروه جدید

[](#اضافه-کردن-گروه-جدید)

```
$contacts->addGroup($groupName,$Descriptions,$showToChilds);
```

#### اضافه کردن کاربر جدید

[](#اضافه-کردن-کاربر-جدید)

```
$contacts->add($options);
```

#### بررسی موجود بودن شماره در دفترچه تلفن

[](#بررسی-موجود-بودن-شماره-در-دفترچه-تلفن)

```
$contacts->checkMobileExist($mobileNumber);
```

#### دریافت اطلاعات دفترچه تلفن

[](#دریافت-اطلاعات-دفترچه-تلفن)

```
$contacts->get($groupId,$keyword,$from,$count);
```

#### دریافت گروه ها

[](#دریافت-گروه-ها)

```
$contacts->getGroups();
```

#### ویرایش مخاطب

[](#ویرایش-مخاطب)

```
$contacts->change($options);
```

#### حذف مخاطب

[](#حذف-مخاطب)

```
$contacts->remove($mobilenumber);
```

#### دریافت اطلاعات مناسبت های فرد

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

```
$contacts->getEvents($contactId);
```

### وب سرویس کاربران

[](#وب-سرویس-کاربران)

#### ثبت فیش واریزی

[](#ثبت-فیش-واریزی)

```
$users->addPayment($options);
```

#### اضافه کردن کاربر جدید در سامانه

[](#اضافه-کردن-کاربر-جدید-در-سامانه)

```
$users->add($options);
```

#### اضافه کردن کاربر جدید در سامانه(کامل)

[](#اضافه-کردن-کاربر-جدید-در-سامانهکامل)

```
$users->addComplete($options);
```

#### اضافه کردن کاربر جدید در سامانه(WithLocation)

[](#اضافه-کردن-کاربر-جدید-در-سامانهwithlocation)

```
$users->addWithLocation($options);
```

#### بدست آوردن ID کاربر

[](#بدست-آوردن-id-کاربر)

```
$users->authenticate();
```

#### تغییر اعتبار

[](#تغییر-اعتبار)

```
$users->changeCredit($amount,$description,$targetUsername,$GetTax);
```

#### فراموشی رمز عبور

[](#فراموشی-رمز-عبور)

```
$users->forgotPassword($mobileNumber,$emailAddress,$targetUsername);
```

#### دریافت تعرفه پایه کاربر

[](#دریافت-تعرفه-پایه-کاربر)

```
$users->getBasePrice($targetUsername);
```

#### دریافت اعتبار کاربر

[](#دریافت-اعتبار-کاربر)

```
$users->getCredit($targetUsername);
```

#### دریافت مشخصات کاربر

[](#دریافت-مشخصات-کاربر)

```
$users->getDetails($targetUsername);
```

#### دریافت شماره های کاربر

[](#دریافت-شماره-های-کاربر)

```
$users->getNumbers();
```

#### دریافت تراکنش های کاربر

[](#دریافت-تراکنش-های-کاربر)

```
$users->getTransactions($targetUsername,$creditType,$dateFrom,$dateTo,$keyword);
```

#### دریافت اطلاعات کاربران

[](#دریافت-اطلاعات--کاربران)

```
$users->get();
```

#### دریافت اطلاعات فیلترینگ

[](#دریافت-اطلاعات--فیلترینگ)

```
$users->hasFilter($text);
```

#### حذف کاربر

[](#حذف-کاربر)

```
$users->remove($targetUsername);
```

#### مشاهده استان ها

[](#مشاهده-استان-ها)

```
$users->getProvinces();
```

#### مشاهده کد شهرستان

[](#مشاهده-کد-شهرستان)

```
$users->getCities($provinceId);
```

#### مشاهده تاریخ انقضای کاربر

[](#مشاهده-تاریخ-انقضای-کاربر)

```
$users->getExpireDate();
```

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity42

Moderate usage in the ecosystem

Community22

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 71.1% 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.

###  Release Activity

Cadence

Every ~650 days

Total

2

Last Release

2338d ago

Major Versions

0.1.0 → 1.0.02019-12-23

### Community

Maintainers

![](https://www.gravatar.com/avatar/1b7b3008220f105dabeb508cf6aa48dd48ee9efdc5c3bfc52e48ac463b738862?d=identicon)[AraCodeIt](/maintainers/AraCodeIt)

---

Top Contributors

[![Melipayamak-Team](https://avatars.githubusercontent.com/u/17405215?v=4)](https://github.com/Melipayamak-Team "Melipayamak-Team (32 commits)")[![amhome](https://avatars.githubusercontent.com/u/36813422?v=4)](https://github.com/amhome "amhome (10 commits)")[![AraCodeIt](https://avatars.githubusercontent.com/u/35146253?v=4)](https://github.com/AraCodeIt "AraCodeIt (2 commits)")[![moreza-kaze](https://avatars.githubusercontent.com/u/99995260?v=4)](https://github.com/moreza-kaze "moreza-kaze (1 commits)")

---

Tags

apismsmelipayamak

### Embed Badge

![Health badge](/badges/melipayamak-php/health.svg)

```
[![Health](https://phpackages.com/badges/melipayamak-php/health.svg)](https://phpackages.com/packages/melipayamak-php)
```

###  Alternatives

[plivo/plivo-php

A PHP SDK to make voice calls & send SMS using Plivo and to generate Plivo XML

1102.8M18](/packages/plivo-plivo-php)[plivo/php-sdk

A PHP SDK to make voice calls & send SMS using Plivo and to generate Plivo XML

1101.9M5](/packages/plivo-php-sdk)[melipayamak/laravel

Laravel Melipayamak Integration

2528.9k1](/packages/melipayamak-laravel)[smsfactor/smsfactor-php-sdk

SMSFactor client library for PHP

15382.5k2](/packages/smsfactor-smsfactor-php-sdk)

PHPackages © 2026

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