README

Official Laravel / PHP SDK for sending SMS via Text.lk 🚀

Easily integrate Text.lk SMS services into your Laravel or PHP applications.

✨ Features

Send SMS messages via Text.lk API
Supports single & multiple recipients
Plain text SMS support
Scheduled SMS support
Check account balance
Fetch account profile
Lightweight & simple API

📦 Installation

Install the package via Composer:

composer require textlk/textlk-laravel

⚙️ Configuration

1. Get your API Key

2. Laravel Environment (.env)

Add your API key to .env:

TEXTLK_API_KEY=your_api_key_here

🚀 Usage

Laravel Example

use TextLK\SMS;

$SMS = new SMS(config('services.textlk.api_key'));

$data = [
    "recipient" => "9476000000", // or "+9476000000,+9476111000"
    "sender_id" => "TEXTLK",
    "type" => "plain",
    "message" => "Boom! Message from Text.lk"
    // "schedule_time" => "2021-12-20T07:00:00Z"
];

$response = $SMS->send($data);

return $response;

🧪 Plain PHP Example (example.php)

<?php

error_reporting(E_ALL);
ini_set('display_errors', 1);

require '../vendor/autoload.php';

use TextLK\SMS;

// Set your API key
$api_key = 'YOUR_API_KEY';

// Instantiate SMS class
$SMS = new SMS($api_key);

$data = [
    "recipient" => "9476000000", // or "+9476000000,+9476111000"
    "sender_id" => "TEXTLK",
    "type" => "plain",
    "message" => "Boom! Message from Text.lk"
    // "schedule_time" => "2021-12-20T07:00:00Z"
];

echo $SMS->send($data);

// echo $SMS->getBalance();
// echo $SMS->getProfile();

📤 Send SMS Parameters

Parameter	Required	Description
`recipient`	✅ Yes	Mobile number(s), comma separated
`sender_id`	✅ Yes	Approved Sender ID
`type`	✅ Yes	`plain`
`message`	✅ Yes	SMS content
`schedule_time`	❌ No	ISO 8601 datetime (UTC)

💰 Check SMS Balance

$balance = $SMS->getBalance();

👤 Get Account Profile

$profile = $SMS->getProfile();

🧩 Laravel Service Configuration (Optional)

Add to config/services.php:

'textlk' => [
    'api_key' => env('TEXTLK_API_KEY'),
],

textlk / textlk-laravel

Maintainers

Details