README

PHP SDK for communicating with the Voodoo SMS API.

Based on GoldSpecDigitals work, it has been updated to work with the updated Voodoo REST API.

Getting Started

These instructions will get you up and running on your local machine and a development environment.

Prerequisites

PHP: >=8.2

Installing

Simply pull in the package in with composer:

$ composer require rustythedalek/voodoo-sms-sdk

Examples

Send an SMS

<?php

use GoldSpecDigital\VoodooSmsSdk\Client;

$client = new Client('api_key');

$response = $client->send('This is a test message', '07712345678');

var_dump($response);

/*
{
    "statusCode": 200,
    "originator": "VoodooSMS",
    ...
}
*/

Get the Delivery Status for an SMS

<?php

use GoldSpecDigital\VoodooSmsSdk\Client;

$client = new Client('api_key');

$response = $client->getDeliveryStatus('A3dads...');

var_dump($response);

/*
{
    "limit": 25,
    "report" [
        {
        "message_id": "97709216074987x3NFD16GgkChK2E67441209181vapi",
        "sender_id": "Chris",
        "to": 447000000000,
        "sent_at": 1542120829,
        "delivered_at": 1542120852,
        "price": 2.9,
        "status": "DELIVERED"
        }
    ]
}
*/

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 - Dependency management
Guzzle - 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.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

rustythedalek / voodoo-sms-sdk

Maintainers

Details