README

The Tawasol SMS Laravel Package is an unofficial module designed to easily integrate SMS functionality into any Laravel project. It provides API endpoints to send SMS messages, check SMS balances, and track delivery statuses using the Tawasol API. It supports SMS messages in multiple formats, including English, Unicode, and Arabic.

Features

Send SMS messages via Tawasol SMS API.
Check SMS balance.
Track message delivery status.
Supports English, Unicode, and Arabic messages.

Installation

You can install the package via Composer. If you are using it as a local package, follow the steps below:

Run the following command to install the package:
```
composer require haniusif/tawasolsms
```

Publish the configuration file:

php artisan vendor:publish --tag=config --provider="Haniusif\\TawasolSms\\TawasolSmsServiceProvider"

Create a config file config/tawasolsms.php for user credentials and API settings:

<?php


return [
'api_url' => env('TAWASOL_SMS_API_URL', 'https://tawasolsms.com:8582/websmpp'),
'accesskey' => env('TAWASOL_SMS_ACCESSKEY', ''),
'sid' => env('TAWASOL_SMS_SID', ''),
 ];

After publishing the configuration file, add your Tawasol SMS credentials in the .env file:

TAWASOL_SMS_SID=your_sender_id
TAWASOL_SMS_API_URL=https://gw14.tawasolsms.com:8582/websmpp
TAWASOL_SMS_ACCESSKEY=your_access_key

Usage

Sending SMS

You can send an SMS using the TawasolSms facade:

use Haniusif\TawasolSms\Facades\TawasolSms;

$recipient = '9665XXXXXXXX';
$message = 'Hello, this is a test message!';

// Send SMS
$response = TawasolSms::sendSms($recipient, $message);

Checking SMS Balance

To check your SMS balance:

use Haniusif\TawasolSms\Facades\TawasolSms;

$balance = TawasolSms::getBalance();

Checking Message Status

You can check the status of a message (e.g., delivered, pending) using the message_id you get when you send an SMS:

use Haniusif\TawasolSms\Facades\TawasolSms;

$messageId = '123456789';
$status = TawasolSms::checkStatus($messageId);

Available Methods

    sendSms($mobileNumber, $message, $type = 1, $respformat = 'json'): Sends an SMS message. The $type can be 1 (English), 2 (Unicode), or 4 (Arabic). Returns the API response or false on failure.

    getBalance($respformat = 'json'): Retrieves the current SMS balance. Returns the balance information or false on failure.

    checkStatus($messageId): Checks the status of a previously sent message using the messageId. Returns the status or false on failure.

    removeScheduledSms($scheduleId): Removes a scheduled SMS batch using the scheduleId. Returns the API response or false on failure.

    sendScheduledSms($mobileNumber, $message, $gmt, $scheduledTime, $type = 1, $respformat = 'json'): Sends an SMS message scheduled for a specific time. The $gmt is the GMT offset (e.g., +0300), and $scheduledTime is the time in yyyyMMddHHmm format. Returns the API response or false on failure.

License

This package is open-sourced software licensed under the MIT license.

haniusif / tawasolsms

Maintainers

Details