README

Taqnyat SMS Laravel is a Laravel package for easy integration with the Taqnyat SMS API, allowing you to send and manage SMS directly within the comfort of your Laravel applications.

Installation

You can install the package via composer:

composer require fateel-tech/taqnyat-sms-laravel

You can publish the config file with:

php artisan vendor:publish --tag="taqnyat-sms-laravel-config"

The following config file will be published in config/taqnyat-sms.php.

return [
    /**
     * This is the URL where the Taqnyat API is located.
     *
     * In most cases, you won't need to change this value.
     */
    'endpoint' => env('TAQNYAT_API_URL', 'https://api.taqnyat.sa'),

    /**
     * This is the sender name that will be used when sending SMS messages.
     */
    'sender_name' => env('TAQNYAT_API_SENDER_NAME', env('APP_NAME')),

    /**
     * This is the token that will be used to authenticate with the Taqnyat API
     */
    'bearer_token' => env('TAQNYAT_API_TOKEN'),

    /**
     * This is the timeout for the HTTP client
     */
    'timeout' => env('TAQNYAT_API_TIMEOUT', 10),
];

Set the TAQNYAT_API_TOKEN and TAQNYAT_API_SENDER_NAME in your .env file.

TAQNYAT_API_SENDER_NAME=*************
TAQNYAT_API_TOKEN=********************************

Usage Examples

use FateelTech\TaqnyatSmsLaravel\Facades\TaqnyatSms;

// Send a message to a single recipient
TaqnyatSms::sendMsg('Hello world', '966500000001');

// Send a message to multiple recipients
TaqnyatSms::sendMsg('Hello world', ['966500000001', '966500000002']);

// Send an advertisement message (appends -AD to the sender name)
TaqnyatSms::asAdvertisement()->sendMsg('Hello world', '966500000001');

// Get the account balance
$accountBalanceInfo = TaqnyatSms::getAccountBalance();
$balance = $accountBalanceInfo->getBalance();
$currency = $accountBalanceInfo->getCurrency();
$expiryDate = $accountBalanceInfo->getExpiryDate();

// Get Taqnyat Service Status
$serviceStatus = TaqnyatSms::getServiceStatus();
$serviceStatus->isUp() // true if the service is up, false otherwise

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

fateel-tech / taqnyat-sms-laravel

Maintainers

Details