README

A Textlocal SMS driver for misaf/laravel-sms-gateway. Requires PHP 8.4+ and Laravel 13.

Installation

composer require misaf/laravel-sms-gateway-textlocal
php artisan sms-gateway-textlocal:install   # or: vendor:publish --tag=sms-gateway-textlocal-config

The service provider auto-registers a textlocal driver on the core manager:

SMS_GATEWAY_DRIVER=textlocal
SMS_GATEWAY_TEXTLOCAL_API_KEY=your-api-key

Usage

use Misaf\LaravelSmsGateway\Facades\SmsGateway;

$response = SmsGateway::driver()->send([
    'numbers' => '447123456789',
    'sender' => 'Laravel',
    'message' => 'Hello from Textlocal',
]);

SmsGateway::driver('textlocal')->send($data);                     // regardless of the default
SmsGateway::driver('textlocal')->request()->get('some/endpoint'); // any other endpoint

send() posts to POST send/, form-encoded. The payload goes straight to Textlocal, so use the fields its API expects. Every send dispatches the core SmsSending, SmsSent, SmsSendFailed and SmsSendUnreachable events with the driver name textlocal — see the core README.

Configuration

config/sms-gateway-textlocal.php:

Key	Env (`SMS_GATEWAY_TEXTLOCAL_…`)	Default
`api_key`	`API_KEY`	—
`base_url`	`BASE_URL`	`https://api.txtlocal.com/`
`timeout.server`	`SERVER_TIMEOUT`	`5`
`timeout.client`	`CLIENT_TIMEOUT`	`6`
`retry.times`	`RETRY_TIMES`	`2`
`retry.sleep_milliseconds`	`RETRY_SLEEP_MILLISECONDS`	`100`

The API key is sent as the apikey query parameter. The credentials and base_url are required and may not be empty: a missing or empty value fails when the driver is resolved. Only connection failures and 5xx responses are retried. Timeouts and the retry policy belong to this driver alone, so tuning it leaves the other gateways untouched.

Contributing

This repository is a read-only split of the monorepo; commits made here are overwritten by the next split. Open issues and pull requests against the monorepo, where this driver lives at Drivers/laravel-sms-gateway-textlocal.

License

MIT. See LICENSE.

misaf / laravel-sms-gateway-textlocal

Package info

Security

Statistics