README

A standalone PHP package for sending SMS with Giant SMS API.

Installation

You can install the Giant SMS Client package using Composer. Run the following command in your terminal:

composer require rootydev/giant-sms-php

This library requires API authentication credentials in order to function. Get your credentials from GiantSMS.com

Usage

To use the GiantSMS Client, include the autoload file and create an instance of the GiantSmsClient class:

require 'vendor/autoload.php';

use RootyDev\GiantSmsClient;

$smsClient = new GiantSmsClient();
$smsClient->sendSms('recipient_number', 'Your message here');

Full API Usage

First, include Composer's autoloader and import the client:

require 'vendor/autoload.php';

use RootyDev\GiantSmsClient\GiantSmsClient;

$smsClient = new GiantSmsClient('your_username', 'your_password', 'YourSenderId', 'your_token');

Sending a Single SMS

$response = $smsClient->sendSingleSms('recipient_number', 'Your message here');
if ($response->getStatus()) {
    echo "Message sent! ID: " . $response->getMessageStatus()->getMessageId();
} else {
    echo "Error: " . $response->getMessage();
}

Checking Message Status

$status = $smsClient->checkMessageStatus('message_id');
if ($status->getStatus()) {
    echo "Status: " . $status->getMessageStatus()->getStatus();
} else {
    echo "Error: " . $status->getMessage();
}

Getting Account Balance

$balance = $smsClient->balance();
echo $balance->getMessage();

Registering a Sender ID

$result = $smsClient->registerSenderId('MySender', 'Transactional');
echo $result->getMessage();

Getting Sender IDs

$senderIds = $smsClient->getSenderIds();
foreach ($senderIds->getSenderIds() as $sender) {
    echo $sender['name'] . " - " . $sender['approval_status'] . PHP_EOL;
}

Sending Bulk SMS

$numbers = ['1234567890', '0987654321'];
$response = $smsClient->sendBulkSms($numbers, 'Bulk message');
echo $response->getMessage();

Sending SMS with Token

$response = $smsClient->sendMessageWithToken('recipient_number', 'Message with token');
echo $response->getMessage();

Running Tests

To run the tests for the SMS Client, use the following command:

vendor/bin/phpunit tests/GiantSmsClientTest.php

Contributing

Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.