k-msalehi/ir-sms

A PHP wrapper for Iranian SMS gateways.

1.2.1 2024-10-27 14:18 UTC

Requires (Dev)

• phpunit/phpunit: ^10.5

MIT

• Mohammad Salehi Koleti

README

This package provides an interface to interact with Iranian SMS gateways for sending SMS messages using patterns.

Installation

To install the package, use Composer:

composer require kmsalehi/ir-sms

Configuration

There is a configuration file in config/ir-sms.php with the following structure:

<?php
return [
    'debug' => true,
    'sms.ir' => [
        'api_key' => 'your_api_key_here',
        'username' => 'your_username_here',
        'password' => 'your_password_here',
    ],
];

You can also create a config/ir-sms-local.php file to override the default configuration.

Usage

Sending SMS by Pattern

To send an SMS using a pattern, use the SmsIr class.