byjg/sms-client

A lightweight, extensible PHP library for sending SMS messages through multiple providers.

5.0.1 2025-04-15 19:58 UTC

Requires

• php: >=8.1 <8.4
• ext-curl: *
• byjg/webrequest: ^5.0

Requires (Dev)

• phpunit/phpunit: ^9.6
• vimeo/psalm: ^5.9

MIT

README

A lightweight, extensible PHP library for sending SMS messages through multiple providers.

Features

• Low code - Simple, intuitive API for sending SMS
• Provider agnostic - Support for multiple SMS providers
• Extensible - Easy to implement custom providers
• Phone formatting - Built-in phone number validation and formatting
• Multi-provider support - Route messages to different providers based on country codes

Installation

composer require byjg/sms-client

Quick Start

use ByJG\SmsClient\Message;
use ByJG\SmsClient\Provider\ProviderFactory;
use ByJG\SmsClient\Provider\TwilioMessagingProvider;
use ByJG\Uri\Uri;

// Register and create provider
ProviderFactory::registerProvider(TwilioMessagingProvider::class);
$provider = ProviderFactory::create(new Uri("twilio://$accountSid:$authToken@default"));

// Send message
$response = $provider->send(
    "[phone]",
    (new Message("Hello World!"))->withSender("[phone]")
);

// Check result
if ($response->isSent()) {
    echo "Message sent successfully!";
}

Documentation

• Basic Usage - Learn how to send SMS messages
• Phone Formatting - Phone number validation and formatting
• Providers - Available SMS providers and configuration
• Custom Providers - Create your own SMS provider

Available Providers

Provider	URI Scheme	Documentation	Region
Twilio Messaging	twilio://accountId:authToken@default	Twilio SMS	Global
Twilio Verify	twilio_verify://accountId:authToken@serviceSid	Twilio Verify	Global
ByJG SMS	byjg://username:password@default	ByJG	Brazil
Fake Sender	fakesender://	Testing only	Testing

Multi-Provider Setup

Route messages to different providers based on country codes:

use ByJG\SmsClient\Provider\ProviderFactory;
use ByJG\SmsClient\Provider\TwilioMessagingProvider;
use ByJG\SmsClient\Provider\ByJGSmsProvider;
use ByJG\SmsClient\Message;

// Register providers
ProviderFactory::registerProvider(TwilioMessagingProvider::class);
ProviderFactory::registerProvider(ByJGSmsProvider::class);

// Associate with country codes
ProviderFactory::registerServices("twilio://accountId:authToken@default", "+1");
ProviderFactory::registerServices("byjg://username:password@default", "+55");

// Automatically routes to the right provider
ProviderFactory::createAndSend("[phone]", new Message("Hello USA!"));
ProviderFactory::createAndSend("[phone]", new Message("Olá Brasil!"));

Phone Number Formatting

Format and validate phone numbers with country-specific rules:

use ByJG\SmsClient\Phone;
use ByJG\SmsClient\PhoneFormat\USPhoneFormat;

$phone = Phone::phone("2345678900", new USPhoneFormat())
    ->withPlusPrefix()
    ->withCountryCode();

echo $phone->hydrate();  // Output: [phone]
echo $phone->format();   // Output: [phone]

// Validate phone numbers
$isValid = $phone->validate(throwException: false);

Dependencies

flowchart TD
    byjg/sms-client --> byjg/webrequest

Loading

Open source ByJG