UGSMS API Documentation

Powerful SMS Messaging API for Ugandan Mobile Numbers

v1 - Username/Password v2 - API Key

API Version 1

Legacy authentication using username and password. Use this if you're migrating from an older system.

Username/Password authentication
Simple integration
Backward compatible

View v1 Docs

API Version 2

Modern authentication using API keys. Recommended for new integrations.

API Key authentication
Better security
Rate limiting
Usage statistics

View v2 Docs

Getting Started

Base URL

https://ugsms.com

Response Format

All API responses are in JSON format. Successful responses have a success: true field, while errors have error field.

Rate Limiting

API requests are limited to 60 requests per minute per API key/user.

Authentication

Username & Password

Include username and password in the request body or query parameters:

{
    "username": "your_username",
    "password": "your_password",
    "numbers": "0702913454",
    "message_body": "Hello"
}

Or as query parameters: ?username=xxx&password=xxx&numbers=xxx&message_body=xxx

API Key Authentication

Use your API key in one of these ways:

1. HTTP Header (Recommended)

X-API-Key: your_api_key_here

2. Query Parameter

GET /api/v2/sms/send?api_key=your_key&numbers=xxx&message_body=xxx

3. Request Body

{
    "api_key": "your_api_key_here",
    "numbers": "0702913454",
    "message_body": "Hello"
}

Note: Generate your API key from the Settings → API Settings page in your dashboard.

Quick Start

Send Your First SMS

curl -X POST "https://ugsms.com/api/v2/sms/send" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "numbers": "0702913454,0776913451",
    "message_body": "Hello from UGSMS API v2"
  }'

Check Balance

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://ugsms.com/api/v2/account/balance"

Ready to get started?

Choose your API version and start integrating.

View v1 Documentation View v2 Documentation

Need Help?