tarwege / sms-whatsapp

2.0.0 2026-09-22 22:34 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ^7.9
• illuminate/support: ^9.0|^10.0

Requires (Dev)

• phpunit/phpunit: ^11.5

MIT

• tarwege

Published on Packagist.org on 2026-09-22 22:53 UTC

README

PHP client for the Tarwege dashboard API (/api/* paths, secret auth, form-encoded POST bodies). Includes Laravel auto-discovery.

Installation

composer require tarwege/sms-whatsapp:^2.0

Laravel — publish config:

php artisan vendor:publish --provider="Tarwege\SmsWhatsapp\Providers\TarwegeServiceProvider" --tag="tarwege-config"

.env:

TARWEGE_API_SECRET=your_api_secret_from_tools_api_keys
TARWEGE_BASE_URL=https://sms.tarwege.com/api

Usage

Inject services or resolve from the container:

use Tarwege\SmsWhatsapp\Services\AccountService;
use Tarwege\SmsWhatsapp\Services\SmsService;
use Tarwege\SmsWhatsapp\Services\OTPService;

$credits = app(AccountService::class)->getCredits();
// ['status' => 200, 'message' => '...', 'data' => ...]

app(SmsService::class)->sendSms([
    'mode' => 'devices',
    'phone' => '[phone]',
    'message' => 'Hello',
    'sim' => 1,
]);

app(OTPService::class)->sendOTP([
    'type' => 'sms',
    'phone' => '[phone]',
    'message' => 'Your code is {{otp}}',
    'expire' => 300,
]);

app(OTPService::class)->verifyOTP('123456');

Standalone (no Laravel):

use Tarwege\SmsWhatsapp\Services\TarwegeClient;
use Tarwege\SmsWhatsapp\Services\SmsService;

$client = new TarwegeClient(getenv('TARWEGE_API_SECRET'), 'https://sms.tarwege.com/api');
$sms = new SmsService($client);

Errors

Non-2xx status in the JSON body throws Tarwege\SmsWhatsapp\Exceptions\TarwegeApiException with the API message and full payload via getResponse().

Service map (official paths)

Service	Methods
AccountService	getEarnings, getCredits, getSubscription
ContactService	createContact, createGroup, deleteContact, deleteGroup, deleteUnsubscribed, getContacts, getGroups, getUnsubscribed
SmsService	sendSms, sendSmsBulk, getDevices, getPendingMessages, getReceivedMessages, getSentMessages, getSmsCampaigns, getSmsMessage, delete*, startSmsCampaign, stopSmsCampaign
WhatsAppService	sendWhatsApp, sendWhatsAppBulk, accounts/chats/campaigns CRUD-style getters and deletes, linkWhatsAppAccount, relinkWhatsAppAccount, getWhatsAppQrImage (token), getWhatsAppInformationAfterLinking (token)
OTPService	sendOTP, verifyOTP
UssdService	sendUssdRequest, getUssdRequests, deleteUssdRequest
SystemService	getGatewayRates, getShorteners
NotificationService	deleteNotification only (no list endpoint in spec)

Older method names (sendSingleMessage, getRemainingCredits, etc.) remain as deprecated aliases where applicable.

Testing

composer test

Changelog

See CHANGELOG.md for 2.0.0 breaking changes and migration from 1.x.

License

MIT — see LICENSE.