https://github.com/kamaroly/ussd
A laravel package to help you work with USSD (Unstructured Supplementary Service Data)
https://github.com/kamaroly/ussd
Last synced: over 1 year ago
JSON representation
A laravel package to help you work with USSD (Unstructured Supplementary Service Data)
- Host: GitHub
- URL: https://github.com/kamaroly/ussd
- Owner: kamaroly
- License: mit
- Created: 2020-11-29T17:08:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-01T20:12:06.000Z (over 5 years ago)
- Last Synced: 2025-01-21T23:32:04.937Z (over 1 year ago)
- Language: PHP
- Size: 38.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# A Laravel package to work with USSD
[](https://packagist.org/packages/kamaro/ussd)
[](https://github.com/kamaro/ussd/actions?query=workflow%3Arun-tests+branch%3Amaster)
[](https://packagist.org/packages/kamaro/ussd)
USSD (Unstructured Supplementary Service Data) is a Global System for Mobile Communications (GSM) protocol that is used to send text messages. USSD is similar to Short Message Service (SMS) with interractive flow between mobile phone and the back-end. USSD uses codes made up of the characters that are available on a mobile phone.
## Features
* Can create unlimited linked flows.
* Can consume API flow display.
* Support multiple languages.
* Support user profile.
* Can do dynamic USSD.
* Can do Static USSD.
* Can do USSD Push.
* Collect and dump Ussd data to URL.
* Can bill per session
* Can bill per period
## Installation
You can install the package via composer:
```bash
composer require kamaro/ussd
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --provider="Kamaro\Ussd\UssdServiceProvider" --tag="migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --provider="Kamaro\Ussd\UssdServiceProvider" --tag="config"
```
This is the contents of the published config file:
```php
return [
];
```
## Usage
``` php
$ussd = new Kamaro\Ussd();
echo $ussd->echoPhrase('Hello, Kamaro!');
```
## Testing
``` bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Kamaro](https://github.com/kamaroly)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.