Developers

SMS API

Send SMS, track delivery and check your balance from your own website, app or system, with a simple REST API.

Sign up for API access Sign in for full docs

Getting started

From sign-up to first message in three steps.

  1. Create your account

    Sign up free and confirm your email address.

  2. Get a Sender ID and an API key

    Request a branded Sender ID, then create an API key from API & Developers in your dashboard.

  3. Make your first call

    Send the key with each request. The full reference, with code in PHP, JavaScript and Python, is waiting in your dashboard.

The basics

Base URL
https://my.fastsmsonline.com/api/v1
Authentication
Authorization: Bearer YOUR_API_KEY
Format
JSON in, JSON out, over HTTPS only.
Phone numbers
Ghanaian mobile numbers in any common format: 0241234567, 233241234567 or +233 24 123 4567.
Sender
Messages go out under your own approved Sender ID.
Rate limit
30 requests per minute per API key.

Example: send an SMS

One request sends one message. Replace YOUR_API_KEY with a key from your dashboard.

Request
curl -X POST "https://my.fastsmsonline.com/api/v1/sms/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "0241234567", "message": "Your order is ready for pickup.", "sender_id": "MyShop"}'
Response
{
  "success": true,
  "data": {
    "message_id": "msg_01jbx4k8w2",
    "status": "queued"
  }
}

Endpoints

What you can do from code.

Paths are relative to the base URL. Parameters and examples for each are in the full reference.

SMS
MethodPathWhat it does
POST /sms/send Send one message
POST /sms/send-bulk Send to up to 5,000 numbers at once
GET /sms/logs List sent messages
GET /sms/delivery-reports List delivery outcomes
GET /sms/delivery-reports/{id} Check one message
Wallet
MethodPathWhat it does
GET /wallet/balance Get your balance
GET /wallet/packages List credit packages
POST /wallet/topup Start a top-up payment
GET /wallet/transactions List top-ups and charges
POST /wallet/settings Set the low-balance alert
Sender IDs
MethodPathWhat it does
GET /sender-ids List your Sender IDs
GET /sender-ids/{sender_id} Check one Sender ID
POST /sender-ids Request a Sender ID
POST /sender-ids/{sender_id}/default Set your default Sender ID
DELETE /sender-ids/{sender_id} Delete a Sender ID

The full reference is in your dashboard

Sign up free to see everything you need to build: every parameter for every endpoint, ready-to-run code in cURL, PHP, JavaScript and Python, example responses, error codes, and your API keys.

  • Step-by-step quick start
  • Parameters and example responses for all 15 endpoints
  • Code samples in four languages
  • Error codes and what to do about each
  • Create and revoke API keys
Create a free account I already have an account

Questions about integrating?

Tell us what you are building and we will help you get it working.

Get StartedContact Support