API Reference

Complete public API surface for Laravel Fast2SMS v2.0.

Facade: Fast2sms

All methods are accessible via the Fast2sms facade or by injecting BaseFast2smsService.

use Shakil\Fast2sms\Facades\Fast2sms;

SMS Methods

quick()

Send a Quick SMS.

Fast2sms::quick(
    string|array $numbers,
    string $message,
    ?SmsLanguage $language = null,
): ResponseInterface

otp()

Send an OTP SMS using a pre-approved template.

Fast2sms::otp(
    string|array $numbers,
    string $otpValue,
): ResponseInterface

dlt()

Send a DLT-registered transactional SMS.

Fast2sms::dlt(
    string|array $numbers,
    string $templateId,
    array|string $variablesValues,
    ?string $senderId = null,
    ?string $entityId = null,
): ResponseInterface

Fluent Builder

For advanced options (flash, schedule, route, etc.) use the fluent builder:

Fast2sms::to(string|array $numbers)
    ->message(string $message)
    ->flash(bool $flash = true)
    ->route(SmsRoute $route)
    ->senderId(string $senderId)
    ->language(SmsLanguage $language)
    ->schedule(string|DateTimeInterface $time)
    ->send(): ResponseInterface

checkBalance()

Retrieve the current wallet balance, optionally checking against a threshold.

Fast2sms::checkBalance(?float $threshold = null): ResponseInterface

dltManager()

Retrieve DLT registration details for the given type.

Fast2sms::dltManager(DltManagerType $type): ResponseInterface

WhatsApp Methods

whatsapp()

Get the WhatsApp service instance.

Fast2sms::whatsapp(): WhatsAppInterface

The returned WhatsApp instance exposes:

->to(string $number): static
->sendText(string $message): WhatsAppResponse
->sendImage(string $url, ?string $caption = null): WhatsAppResponse
->sendDocument(string $url, ?string $filename = null, ?string $caption = null): WhatsAppResponse
->sendLocation(float $lat, float $lng, ?string $name = null, ?string $address = null): WhatsAppResponse
->sendInteractive(array $payload): WhatsAppResponse
->sendReaction(string $messageId, string $emoji): WhatsAppResponse
->block(string|array $numbers): WhatsAppResponse
->unblock(string|array $numbers): WhatsAppResponse
->getBlockedUsers(): WhatsAppResponse
->getDeliveryReport(string $requestId): WhatsAppResponse
->getSummary(string $from, string $to): WhatsAppResponse
->getLogs(string $from, string $to): WhatsAppResponse
->getWabaDetails(string $type = 'sender'): WhatsAppResponse
->uploadMedia(string $path, string $type): WhatsAppResponse

Queue Methods

onQueue() / onConnection()

Per-send queue overrides — call these before dispatching a send to override the default queue or connection for that call only.

Fast2sms::onQueue(string $queue): static
Fast2sms::onConnection(string $connection): static

Throws ConfigurationException if queue.enabled is false.

Fake / Testing Methods

fake()

Activate the fake — prevents real HTTP calls.

$fake = Fast2sms::fake();

SMS Assertions

Fast2sms::assertSmsSent(?Closure $callback = null): void
Fast2sms::assertSmsNotSent(?Closure $callback = null): void
Fast2sms::assertSmsSentCount(int $count): void
Fast2sms::assertSmsSentTo(string $number): void
Fast2sms::assertSmsSentWithMessage(string $message): void
Fast2sms::assertSmsSentWithRoute(SmsRoute $route): void

WhatsApp Assertions

Fast2sms::assertWhatsAppSent(?Closure $callback = null): void
Fast2sms::assertWhatsAppNotSent(?Closure $callback = null): void
Fast2sms::assertWhatsAppSentCount(int $count): void
Fast2sms::assertWhatsAppSentTo(string $number): void
Fast2sms::assertWhatsAppSentWithType(WhatsAppType $type): void

Combined Assertions

Fast2sms::assertNothingSent(): void
Fast2sms::assertSentCount(int $count): void
Fast2sms::assertSentTimes(int $count): void
Fast2sms::assertSent(array|Closure|null $callback = null): void
Fast2sms::assertNotSent(array|Closure|null $callback = null): void

Resetting the Fake

Call reset() on the Fast2smsFake instance returned by Fast2sms::fake():

$fake = Fast2sms::fake();
$fake->reset();

assertSent() is a low-level generic assertion that matches across both SMS and WhatsApp recorded sends. Pass a closure for custom matching logic. assertNotSent() is its generic counterpart — asserts no message (or no matching message) was sent. assertSentTimes() asserts the exact total number of messages sent across all channels.

Static Methods

events()

Returns a map of all package event classes to their descriptions.

Fast2sms::events(): array<class-string, string>

Response Objects

SmsResponse

WhatsAppResponse

WalletBalanceResponse

DltManagerResponse

Enums

SmsRoute

SmsLanguage

WhatsAppType

DltManagerType

Exceptions

Artisan Commands

SmsMessage Credit Helpers

These methods let you estimate SMS credit consumption before sending.

use Shakil\Fast2sms\Notifications\Messages\SmsMessage;

$msg = SmsMessage::create('Hello!');

$msg->charCount();      // int   — number of characters in the message
$msg->isUnicode();      // bool  — true if the message contains non-GSM-7 characters
$msg->creditCount();    // int   — estimated number of SMS credits consumed
$msg->exceedsOneSms();  // bool  — true if the message spans more than one SMS part

Credit calculation rules:

See Also

• SMS Guide
• WhatsApp Guide
• Testing
• Error Handling
• Cost-Saving Features