byjg/sms-client

A generic and extensible lightweight sms client to publish SMS service providers like Twilio and ByJG.

4.9.0 2024-01-05 23:27 UTC

Requires

• php: >=7.4.0
• ext-curl: *
• byjg/webrequest: 4.9.*

Requires (Dev)

• phpunit/phpunit: 5.7.*|7.4.*|^9.5

MIT

README

This is a simple client to send SMS using different providers.

Features

• Low code to send SMS
• Classes totally decoupled
• Easy to implement new providers

Usage

Using ProviderFactory

// Register the provider and associate with a scheme
ProviderFactory::registerProvider(TwilioMessagingProvider::class);

// Create a provider
$provider = ProviderFactory::create(new Uri("twilio://$accountSid:$authToken@default"));

// Send a message
$response = $byjg->send("12221234567", (new \ByJG\SmsClient\Message("This is a test message")->withSender("[phone]"));

// Check if the message was sent
if ($response->isSent()) {
    echo "Message sent";
} else {
    echo "Message not sent";
}

Using ProviderFactory to send a message to multiple providers depending on the country

// Register the provider and associate with a scheme
ProviderFactory::registerProvider(TwilioMessagingProvider::class);
ProviderFactory::registerProvider(ByJGSmsProvider::class);

// Define the provider according to the country prefix
ProviderFactory::registerServices("twilio://accoundId:authToken@default", ["+1"]);
ProviderFactory::registerServices("byjg://username:password@default", ["+55"]);

// Send a message and select the provider according to the country prefix
$response = ProviderFactory::createAndSend("[phone]", (new \ByJG\SmsClient\Message("This is a test message")));
var_dump($response);

$response = ProviderFactory::createAndSend("[phone]", (new \ByJG\SmsClient\Message("This is a test message"))->withSender("[phone]"));
var_dump($response);

Providers

The providers are the classes responsible to send the text message.

All providers have the following interface:

<?php
interface ProviderInterface
{
    public static function schema();

    public function setUp(Uri $uri);

    public function send($to, Message $envelope): ReturnObject;
}

There is no necessary call the method getConnection() because the method publish() and consume() will call it automatically. Use the method getConnection() only if you need to access the connection directly.

Implemented providers

provider	URL / Documentation	Specifics
twilio://accoundId:authToken@default	Send a message using the Twilio messaging provider.	Message object requires withSender to set.
twilio_verify://accoundId:authToken@serviceSid	Send a message using the Twilio verify verify provider.	Message with empty body send the SMS with the OTP code. To validate the received OTP, needs to pass it to the Message::body
byjg://username:password@default	Send a message using the ByJG provider.	Only Brazil.
fakesender://	Fake sender to be used on tests.	Only for tests. Do not send messages.

Install

composer require "byjg/sms-client"

Dependencies

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

Open source ByJG

Open source ByJG