https://github.com/greensms-io/greensms-php
PHP GREENSMS API client: SMS, Call, Voice, VK, WhatsApp, Viber
https://github.com/greensms-io/greensms-php
2fa-codes call-for-code sms sms-api sms-notifications sms-verification viber-api
Last synced: about 2 months ago
JSON representation
PHP GREENSMS API client: SMS, Call, Voice, VK, WhatsApp, Viber
- Host: GitHub
- URL: https://github.com/greensms-io/greensms-php
- Owner: greensms-io
- Created: 2020-11-11T04:37:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T15:47:26.000Z (3 months ago)
- Last Synced: 2025-03-28T07:38:25.122Z (about 2 months ago)
- Topics: 2fa-codes, call-for-code, sms, sms-api, sms-notifications, sms-verification, viber-api
- Language: PHP
- Homepage: https://api.greensms.io
- Size: 102 KB
- Stars: 26
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# greensms-php
[](https://github.com/greensms-ru/greensms-php/actions/workflows/php.yml)
## Documentation
The documentation for the GREENSMS API can be found [here][apidocs].
## Installation
```bash
composer require greensms/greensms
```
## Sample Usage
Check out these [code examples](examples) to get up and running quickly.
```php
use GreenSMS\GreenSMS;
# Register at my.greeensms.ru first
$client = new GreenSMS([
'user' => 'test',
'pass' => 'test'
]);
$response = $client->sms->send([
'to' => '79260000121',
'txt' => 'Here is your message for delivery'
]);
echo "Sms Request Id: " . $response->request_id;
```
### Environment Variables
`greensms-php` supports credential storage in environment variables. If no credentials are provided following env vars will be used: `GREENSMS_USER`/`GREENSMS_PASS` OR `GREENSMS_TOKEN`.
### Token Auth
```php
use GreenSMS\GreenSMS;
$tokenClient = new GreenSMS([
'token' => 'yourtoken'
]);
$response = $tokenClient->account->balance();
echo "Balance : " . $response->balance. "\n";
```
## Compatibility
`greensms-php` is compatible with PHP 7.3+ onwards until the latest PHP Version
## Methods
- You can either use username/password combination or auth token to create an object with constructor
- Each API Function is available as `MODULE.FUNCTION()`
- Parameters for each API can be referred from [here][apidocs]
- Response keys by default are available in `snake_case`. If you want to use `camelCase`, then pass `'camelCaseResponse'= > true`, in the constructor
## Handling Exceptions
- Exceptions for all APIs are thrown with RestException class. It extends the default PHP Exception class.
- Each error, will have a message and code similar to PHP Exceptions.
- In case of _Validation Error_, additional params are available to show field-wise rule failures. Can be accessed by `$e->getParams()` method on the error object
## Getting help
If you need help installing or using the library, please contact us: [[email protected]](mailto:[email protected]).
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
## Contributing
Bug fixes, docs, and library improvements are always welcome. Please refer to our [Contributing Guide](CONTRIBUTING.md) for detailed information on how you can contribute.
If you're not familiar with the GitHub pull request/contribution process, [this is a nice tutorial](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
### Getting Started
If you want to familiarize yourself with the project, you can start by [forking the repository](https://help.github.com/articles/fork-a-repo/) and [cloning it in your local development environment](https://help.github.com/articles/cloning-a-repository/). The project requires [Node.js](https://nodejs.org) to be installed on your machine.
After cloning the repository, install the dependencies by running the following command in the directory of your cloned repository:
```bash
composer require
```
GreenSMS has all the unit tests defined under **tests** folder with `*Test.php` extension. It uses PHPUnit, which is added as a dev dependency. You can run all the tests using the following command.
```bash
./vendor/bin/phpunit tests
```
[apidocs]: https://api.greensms.io/