https://github.com/goldspecdigital/voodoo-sms-sdk
PHP SDK for communicating with the Voodoo SMS API.
https://github.com/goldspecdigital/voodoo-sms-sdk
goldspec-digital gsd open-source php sdk sms voodoo
Last synced: 3 months ago
JSON representation
PHP SDK for communicating with the Voodoo SMS API.
- Host: GitHub
- URL: https://github.com/goldspecdigital/voodoo-sms-sdk
- Owner: goldspecdigital
- License: mit
- Created: 2017-12-27T21:11:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-30T11:52:41.000Z (almost 7 years ago)
- Last Synced: 2025-01-08T16:04:50.531Z (4 months ago)
- Topics: goldspec-digital, gsd, open-source, php, sdk, sms, voodoo
- Language: PHP
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Voodoo SMS PHP SDK
PHP SDK for communicating with the Voodoo SMS API.
## Getting Started
These instructions will get you up and running on your local machine and a development environment.
### Prerequisites
* PHP: >=7.2
### Installing
Simply pull in the package in with composer:
```
$ composer require goldspecdigital/voodoo-sms-sdk
```
### Examples
#### Send an SMS
```php
send('This is a test message', '07712345678');
var_dump($response);
/*
{
"result": 200,
"resultText": "200 OK",
"reference_id": ["A3dads..."]
}
*/
```
#### Get the Delivery Status for an SMS
```php
getDeliveryStatus('A3dads...');
var_dump($response);
/*
{
"result": "200 OK",
"reference_id": "A3dads...",
"message": "This is a test message",
"delivery_status": "Delivered",
"delivery_datetime": "2017-12-28 00:06:09"
}
*/
```
## Running the tests
To run the test you will need to have Voodoo SMS credentials stored in a `.env` file placed in the project root. An example file is provided for you with the keys required: `.env.example`.
You can run the tests in an environment running PHP >=7.2 with PHP Unit:
```
$ vendor/bin/phpunit
```
### And coding style tests
This project follows PSR1 and PSR2 coding standards as well as enabling strict types on all PHP files.
Before making any commits, make sure your code passes the linter by running:
```
$ vendor/bin/phpcs
```
## Built With
* [Composer](https://getcomposer.org/) - Dependency management
* [Guzzle](http://docs.guzzlephp.org/) - The HTTP client to Communicate with the Voodoo SMS API
## Contributing
Feel free to issue a pull request, although any requests that fail PHPUnit or the linter will be automatically rejected.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/goldspecdigital/voodoo-sms-sdk/tags).
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details