blackm13/melipayamak

There is no license information available for the latest version (dev-main) of this package.

Laravel 10+ package for MeliPayamak SMS service

dev-main 2025-03-22 12:30 UTC

Requires

• php: >=8.0
• illuminate/support: ^10.0

Unknown License

README

A simple PHP package for interacting with the Payamak SMS API to send and manage SMS messages effortlessly.

Table of Contents

• Installation
• Configuration
• Usage
  • Sending SMS
  • Sending Multiple SMS
  • Getting Delivery Status
  • Retrieving Messages
  • Checking Credit
  • Getting Base Price
  • Getting User Numbers
• Contributing
• License

Installation

Install the package via Composer:

composer require black-m13/meli-payamak

Register Service Provider (Laravel 10+)

The service provider is automatically registered via Laravel's package discovery. However, if needed, manually add it in config/app.php:

'providers' => [
    BlackM13\MeliPayamak\SmsServiceProvider::class,
],

Alias the Facade

Add the alias in config/app.php to use SmsService statically:

'aliases' => [
    'SmsService' => BlackM13\MeliPayamak\Facades\SmsService::class,
],

Usage

Sending SMS

Send an SMS using the sendSMS method:

use SmsService;

$response = SmsService::sendSMS('09123456789', '1000', 'Your message here');

Sending Multiple SMS

To send different messages to multiple recipients, use sendMultipleSMS:

$response = SmsService::sendMultipleSMS(
    ['09123456789', '09129876543'],
    '1000',
    ['Message for first recipient', 'Message for second recipient']
);

Getting Delivery Status

Check the delivery status of a sent SMS using getDeliveryStatus with the recID received during sending:

$response = SmsService::getDeliveryStatus('recID');

Retrieving Messages

Get a list of sent or received messages using getMessages. Use 2 for sent messages:

$response = SmsService::getMessages(2);

Checking Credit

Retrieve your SMS credit balance with getCredit:

$response = SmsService::getCredit();

Getting Base Price

Retrieve the base price for sending SMS using getBasePrice:

$response = SmsService::getBasePrice();

Getting User Numbers

Get a list of your dedicated numbers using getUserNumbers:

$response = SmsService::getUserNumbers();

Contributing

Contributions are welcome! If you encounter issues or have suggestions, feel free to open an issue or submit a pull request.

License

This package is licensed under the MIT License. See the LICENSE file for details.