PHPackages                             asanak/php-sms-client - 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. asanak/php-sms-client

ActiveLibrary[API Development](/categories/api)

asanak/php-sms-client
=====================

A modern PHP SMS client for sending and reporting messages via REST API

v1.0.0(1y ago)02PHPPHP ^8.0

Since Jun 29Pushed 1y agoCompare

[ Source](https://github.com/Asanak-Team/php-sms-client)[ Packagist](https://packagist.org/packages/asanak/php-sms-client)[ Docs](https://github.com/Asanak-Team/php-sms-client)[ RSS](/packages/asanak-php-sms-client/feed)WikiDiscussions main Synced today

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

📦 SMS Client PHP
================

[](#-sms-client-php)

یک کلاینت مدرن PHP برای ارسال پیامک، پیامک نظیر به نظیر، پیامک خدماتی و دریافت گزارش‌ها از طریق یک سرویس RESTful.

📌 ویژگی‌ها
----------

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

- ارسال پیامک تکی یا چندمقصدی
- ارسال پیامک نظیر به نظیر (P2P)
- ارسال پیامک خدماتی با قالب (OTP)
- دریافت گزارش وضعیت پیامک
- مشاهده موجودی اعتبار پیامکی
- قابل توسعه، تمیز و قابل مانیتورینگ

---

🔧 نصب پکیج
----------

[](#-نصب-پکیج)

در ترمینال خود اجرا کنید:

```
composer require asanak/php-sms-client
```

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

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

1- مقداردهی اولیه کلاینت:

```
use Asanak\SmsClient;
use Asanak\SmsConfig;

$config = new SmsConfig([
    'base_url' => 'https://sms.asanak.ir'
]);
$sms = new SmsClient('your-username', 'your-password', $config);
```

2- ارسال پیامک تکی یا چند مقصدی

```
try {
    $data = $sms->sendSms(
        source: '9821XXXXX',
        destination: '09120000000',
        message: 'کد فعالسازی شما 123456 می‌باشد.',
        send_to_black_list: false
    );
    // $data is message ids list
} catch(\Throwable $th) {
    echo $th->getMessage();
}
```

3- ارسال پیامک نظیر به نظیر (P2P)

```
try{
    $data = $sms->p2p(
        source: ['9821X1', '9821X2'],
        destination: ['0912XXXX1', '0912XXXX2'],
        message: ['متن پیامک شماره یک', 'متن پیامک شماره دو'],
        send_to_black_list: [false, true]
    );
    $messageIds = array_column($data, 'messageId');
} catch(\Throwable $th) {
    echo $th->getMessage();
}
```

4- ارسال پیامک خدماتی با قالب (OTP)

```
try{
    $data = $sms->template(
        template_id: 101,
        parameters: ['code' => 123456],
        destination: '09120000000',
        send_to_black_list: false
    );
    // $data is message ids list
} catch(\Throwable $th) {
    echo $th->getMessage();
}
```

5- استعلام وضعیت پیامک

```
$response = $sms->msgStatus(['12345678', '12345679']);
```

6- مشاهده موجودی اعتبار پیامکی

```
try {
    $data = $sms->getCredit();
    $credit = $data['credit'] ?? null;
} catch(\Throwable $th) {
    echo $th->getMessage();
}
```

7- مشاهده موجودی اعتبار پیامکی (ریال)

```
try {
    $data = $sms->getRialCredit();
    $credit = $data['credit'] ?? null;
} catch(\Throwable $th) {
    echo $th->getMessage();
}
```

8- دریافت لیست قالب‌های پیامک

```
try {
    $templates = $sms->getTemplates();
} catch(\Throwable $th) {
    echo $th->getMessage();
}
```

🧰 لاگ‌گذاری و مانیتورینگ (اختیاری)
----------------------------------

[](#-لاگ‌گذاری-و-مانیتورینگ-اختیاری)

اگر قصد دارید لاگ‌ها را ذخیره کنید، می‌توانید از Monolog استفاده نمایید:

```
composer require monolog/monolog
```

```