TXTLINK

Quick Start

Get up and running with TXTLINK in 5 minutes. Follow these steps to send your first SMS.

1

Create account

(2 min)

Sign up for a free TXTLINK account. No credit card required.

2

Generate API key

(1 min)

Navigate to Settings → API Keys and create a new API key.

3

Install SDK

(1 min)

Install the TXTLINK SDK for your preferred language.

4

Send first SMS

(1 min)

Use the SDK to send your first SMS message.

5

Receive delivery report

(optional)

Set up webhooks to receive delivery status updates (optional).

1

Create account

Sign up for a free TXTLINK account. You'll get access to test API keys and can send up to 100 SMS messages for free during development.

2

Choose Authentication Method

TXTLINK supports two authentication methods. Choose the one that works best for you:

Option A: API Key (Recommended)

Recommended

Navigate to Settings → API Keys and create a new API key. Copy it immediately—you won't be able to see it again.

Best for production

More secure and easier to manage. Use for production applications.

Option B: Username/Password

Use your account email and password. No setup required—just use your login credentials.

Great for testing

Quick and easy. Perfect for testing and simple integrations.

Keep credentials secure

Never expose API keys or passwords in frontend code or commit them to version control. Always use environment variables.
3

Install SDK

Install the TXTLINK SDK for your preferred programming language:

bash
npm install @txtlink/sdk
4

Send first SMS

Send your first SMS using the REST API. Replace the phone number with your own to receive a test message. Examples below show both authentication methods.

javascript
// Using API Key (Recommended)
const response = await fetch('https://api.txtlink.com/api/v1/sms/send', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.TXTLINK_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    to: '+254712345678',
    message: 'Hello from TXTLINK!',
    senderIdName: 'TXTLINK'
  })
})

const result = await response.json()
console.log('Message ID:', result.messageId)
console.log('Status:', result.status)

You'll receive an SMS instantly

After running this code, you should receive an SMS on the phone number you specified within seconds. Make sure you have an approved sender ID!

Expected Response

json
{
  "success": true,
  "messageId": "507f1f77bcf86cd799439011",
  "segments": 1,
  "totalCredits": 1,
  "totalCostKes": 2.0,
  "newBalance": 99,
  "status": "queued",
  "to": "+254712345678",
  "senderId": "TXTLINK"
}

Next Steps