📱 SMS Gateway for AndroidTM PHP API Client

🔖 Table of Contents

✨ Features

⚙️ Prerequisites

📦 Installation

composer require capcom6/android-sms-gateway

🚀 Quickstart

Sending an SMS

<?php
require 'vendor/autoload.php';
use AndroidSmsGateway\Client;
use AndroidSmsGateway\Domain\MessageBuilder;
// Initialize client with credentials
$client = new Client('your_login', 'your_password');
// Build message with fluent interface
$message = (new MessageBuilder('Your message text here.', ['+1234567890']))
 ->setTtl(3600) // Message time-to-live in seconds
 ->setSimNumber(1) // Use SIM slot 1
 ->setWithDeliveryReport(true) // Request delivery report
 ->setPriority(100) // Higher priority message
 ->build();
// Send message
try {
 $messageState = $client->SendMessage($message);
 echo "✅ Message sent! ID: " . $messageState->ID() . PHP_EOL;
 
 // Check status after delay
 sleep(5);
 $updatedState = $client->GetMessageState($messageState->ID());
 echo "📊 Message status: " . $updatedState->State() . PHP_EOL;
} catch (\Exception $e) {
 echo "❌ Error: " . $e->getMessage() . PHP_EOL;
 exit(1);
}

Managing Devices

// List registered devices
$devices = $client->ListDevices();
echo "📱 Registered devices: " . count($devices) . PHP_EOL;
// Remove a device
try {
 $client->RemoveDevice('device-id-123');
 echo "🗑️ Device removed successfully" . PHP_EOL;
} catch (\Exception $e) {
 echo "❌ Device removal failed: " . $e->getMessage() . PHP_EOL;
}

🔐 Authentication

Basic Authentication

// Initialize client with Basic authentication
$client = new Client('your_login', 'your_password');

JWT Authentication

Generating a JWT Token

use AndroidSmsGateway\Client;
use AndroidSmsGateway\Domain\TokenRequest;
// First, create a client with Basic authentication to generate a token
$basicClient = new Client('your_login', 'your_password');
// Create a token request with specific scopes and TTL
$tokenRequest = new TokenRequest(
 ['messages:send', 'messages:read'], // Scopes for permissions
 3600 // Token TTL in seconds (optional)
);
// Generate the token
$tokenResponse = $basicClient->GenerateToken($tokenRequest);
$jwtToken = $tokenResponse->AccessToken();
echo "Token generated! Expires at: " . $tokenResponse->ExpiresAt() . PHP_EOL;

Using a JWT Token

// Initialize client with JWT authentication
$jwtClient = new Client(null, $jwtToken);
// Now use the client as usual
$message = (new MessageBuilder('Your message text here.', ['+1234567890']))->build();
$messageState = $jwtClient->SendMessage($message);

Revoking a JWT Token

// Revoke a token using its ID (jti)
$basicClient->RevokeToken($tokenResponse->ID());
echo "Token revoked successfully!" . PHP_EOL;

📚 Full API Reference

Client Initialization

Basic Authentication

$clientBasic = new Client(
 string $login,
 string $password,
 string $serverUrl = 'https://api.sms-gate.app/3rdparty/v1',
 ?\Psr\Http\Client\ClientInterface $httpClient = null,
 ?\AndroidSmsGateway\Encryptor $encryptor = null
);
$clientJWT = new Client(
 null, // Set login to null for JWT
 string $jwtToken, // JWT token as the second parameter
 string $serverUrl = 'https://api.sms-gate.app/3rdparty/v1',
 ?\Psr\Http\Client\ClientInterface $httpClient = null,
 ?\AndroidSmsGateway\Encryptor $encryptor = null
);

Core Methods

Builder Methods

// Message Builder
$message = (new MessageBuilder(string $text, array $recipients))
 ->setTtl(int $seconds)
 ->setSimNumber(int $simSlot)
 ->setWithDeliveryReport(bool $enable)
 ->setPriority(int $value)
 ->build();

🔒 Security Notes

Best Practices

Encryption Support

use AndroidSmsGateway\Encryptor;
// Initialize client with encryption
$encryptor = new Encryptor('your-secret-passphrase');
$client = new Client($login, $password, Client::DEFAULT_URL, null, $encryptor);

👥 Contributing

Development Setup

git clone https://github.com/android-sms-gateway/client-php.git
cd client-php
composer install

📄 License