A comprehensive PHP library for sending SMS messages through various Iranian SMS providers.
This package provides a unified interface for sending SMS messages through different SMS gateways/providers in Iran. It follows SOLID principles with a simple adapter pattern that allows you to easily switch between different SMS service providers.
- FarazSMS
- SMSir
- FaraPayamak
- Payamito
- Elanak
- MedianaSMS
- PHP 8.0 or higher
- curl extension enabled
Install the package via Composer:
composer require jamal13647850/sms-api<?php
use jamal13647850\smsapi\FarazSMS;
use jamal13647850\smsapi\SMS;
// Create a gateway instance (e.g., FarazSMS)
$gateway = new FarazSMS(
'your_username',
'your_password',
'your_sender_number'
);
// Create the SMS service with your chosen gateway
$sms = new SMS($gateway);
// Send a simple SMS
$result = $sms->sendSMS('09120000000', 'Hello, this is a test message');
// Check the result
if ($result['status']) {
echo "SMS sent successfully!";
} else {
echo "Failed to send SMS. Error: " . print_r($result, true);
}
// Check your account balance
$credit = $sms->getCredit();
echo "Your remaining credit: " . $credit;$result = $sms->sendSMS('09120000000', 'Your message here');$numbers = ['09120000000', '09987654321'];
$result = $sms->sendSMS($numbers, 'Your message here');Some providers support pattern-based messages (templates):
$parameters = [
'name' => 'John',
'code' => '1234'
];
$result = $sms->sendSMSByPattern('09120000000', '', 12345, $parameters);Note: The pattern ID (12345 in this example) and parameter format may vary between providers.
$credit = $sms->getCredit();$gateway = new FarazSMS(
'your_username',
'your_password',
'your_sender_number',
'https://ippanel.com/services.jspd' // optional URL
);$gateway = new SMSir(
'your_api_key',
'your_sender_number',
'https://api.sms.ir/v1/send/' // optional URL
);$gateway = new FaraPayamak(
'your_username',
'your_password',
'your_sender_number',
'https://rest.payamak-panel.com/api/SendSMS/' // optional URL
);$gateway = new Elanak(
'http://158.58.186.243/webservice/', // optional URL
'your_username',
'your_password',
'your_sender_number'
);$gateway = new MedianaSMS(
'your_username',
'your_password',
'your_sender_number',
'https://ippanel.com/services.jspd' // optional URL
);One of the main advantages of this library is the ability to easily switch between different SMS providers:
// Using FarazSMS
$farazGateway = new FarazSMS('username', 'password', 'number');
$sms = new SMS($farazGateway);
$sms->sendSMS('09120000000', 'Test message');
// Switch to SMSir
$smsirGateway = new SMSir('api_key', 'number');
$sms = new SMS($smsirGateway);
$sms->sendSMS('09120000000', 'Test message');Most methods return an array with status information:
$result = $sms->sendSMS('09120000000 ', 'Test message');
if ($result['status']) {
// Success
$messageId = $result['resultData'];
} else {
// Error
$errorCode = $result['resultCode'];
$errorMessage = $result['resultData'];
}Different providers return different response formats. The library standardizes these responses, but provider-specific details may still be available:
$result = $sms->sendSMS('09120000000', 'Test message');
// Common fields across all providers
$success = $result['status']; // boolean
$resultCode = $result['resultCode']; // int
$resultData = $result['resultData']; // mixed (can be message ID, array of IDs, etc.)
// Some providers may include additional data in the responseContributions are welcome! Here's how you can help:
- Fork the repository
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
This project is licensed under the MIT License - see the LICENSE file for details.