README

FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک)

• https://farazsms.com
• https://iranpayamak.com

Symfony bundle that autowires the farazsms/php client into your application, configured from environment variables. Supports Symfony 6 & 7 and PHP >= 8.1.

Installation

composer require farazsms/symfony-bundle

With Symfony Flex the bundle is registered automatically. Otherwise add it to config/bundles.php:

return [
    // ...
    FarazSMS\SymfonyBundle\FarazSMSBundle::class => ['all' => true],
];

Configuration

Create config/packages/farazsms.yaml:

farazsms:
    api_key: '%env(FARAZSMS_API_KEY)%'
    # base_url defaults to https://api.iranpayamak.com
    # base_url: '%env(FARAZSMS_BASE_URL)%'

Set the API key in your .env:

FARAZSMS_API_KEY=your-api-key-here

Usage

The FarazSMS\FarazSMS client is registered as a service and can be autowired directly into your own services and controllers:

use FarazSMS\FarazSMS;

final class NotificationService
{
    public function __construct(private FarazSMS $sms) {}

    public function notify(): void
    {
        $this->sms->sendPattern('your-pattern-code', '0912xxxxxxx', [
            'name' => 'Ali',
        ]);

        // or a simple message:
        // $this->sms->sendSimple('Hello', ['0912xxxxxxx'], '90008361');

        // check balance:
        // $balance = $this->sms->balance();
    }
}

License

Released under the MIT License. Copyright (c) 2026 FarazSMS.