Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/extendy/jormall-sms-bundle
A Symfony bundle to deal with Jormall SMS API
https://github.com/extendy/jormall-sms-bundle
jormallsms sms-api sms-client symfony-bundle symfony7
Last synced: about 1 month ago
JSON representation
A Symfony bundle to deal with Jormall SMS API
- Host: GitHub
- URL: https://github.com/extendy/jormall-sms-bundle
- Owner: Extendy
- License: mit
- Created: 2024-06-14T12:27:31.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T09:42:55.000Z (3 months ago)
- Last Synced: 2024-09-30T16:04:48.747Z (about 2 months ago)
- Topics: jormallsms, sms-api, sms-client, symfony-bundle, symfony7
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Jormall SMS Bundle
This is a Symfony bundle that provides an easy way to send SMS using the [Jormall SMS web service](http://josmsservice.com/).
## 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`:
```json
"require": {
"extendy/jormall-sms-bundle": "0.0.0-beta.1"
}
```
or by running:
```bash
composer require extendy/jormall-sms-bundle
```
edit tour `.env` file and add the following (and replace the values with your Jormall sms account details):
```dotenv
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
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](./LICENSE) file for details.