extendy/jormall-sms-bundle

A Symfony bundle to send SMS using Jormall SMS API

1.0.2 2024-08-25 09:42 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.8
• symfony/framework-bundle: ^7.0

Requires (Dev)

• phpunit/phpunit: ^11.2

MIT

• Mohammed AlShannaq

README

This is a Symfony bundle that provides an easy way to send SMS using the Jormall SMS web service.

Features

• Send SMS messages using the Jormall SMS API.
• Get the balance of the account.
• Handle connection and request errors gracefully.

Requirements

• PHP 8.2 or higher
• GuzzleHttp 7.8 or higher
• Symfony Framework Bundle 7.0 or higher
• User must have an active SMS account with JorMall
• The SMS account must have SMS balance.
• The used sender through this web service must be registered by JorMall before its being used.

Installation

Add the following to your composer.json:

"require": {
    "extendy/jormall-sms-bundle": "0.0.0-beta.1"
}

or by running:

composer require extendy/jormall-sms-bundle

edit tour .env file and add the following (and replace the values with your Jormall sms account details):

JORMALLSMS_SENDERID=SENDERNAME
JORMALLSMS_ACCNAME=ACCOUNTUSERNAME
JORMALLSMS_ACCPASS=ACCOUNTPASSWORD

Usage

You can use the JormallSmsService service to send SMS messages or get the balance. Here is an example (while using it in a controller):

<?php

namespace App\Controller;

use Extendy\JormallSmsBundle\Service\JormallSmsService;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

class TestController extends AbstractController
{
    private $jormallSmsService;

    public function __construct(JormallSmsService $jormallSmsService)
    {
        $this->jormallSmsService = $jormallSmsService;
    }


    #[Route('/test', name: 'app_test')]
    public function index()
    {
        $msg = "Hello, this is a test message";
        // send sms
        dd($this->jormallSmsService->sendSms("962777774221", $msg, "1"));

    }

    #[Route('/test/balance', name: 'app_test_balance')]
    public function balance()
    {
        // get sms balance
        dd($this->jormallSmsService->getBalance());

    }

}

License

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