Docs
DocumentationExamplesDashboard →

Getting Started

  • Introduction
  • Authentication
  • Base URL

API Reference

  • Sending SMS
  • Scheduled SMS
  • Sender IDs

Resources

  • Error Responses
  • Code Examples

Sender IDs

Sender IDs are the names that appear as the sender when recipients receive your SMS messages.

What is a Sender ID?

A Sender ID is an alphanumeric name (up to 11 characters) that identifies who sent the message. For example:

MyCompany
AlertSys
BankXYZ

Requirements

  • Maximum length: 11 characters
  • Allowed characters: A-Z, a-z, 0-9, spaces
  • Cannot be: Only numbers (must include letters)
  • Must be: Approved by admin before use

Creating a Sender ID

Sender IDs must be created and approved through the dashboard:

  1. Log in to your dashboard
  2. Navigate to Sender IDs
  3. Click Create New Sender ID
  4. Enter your desired sender name
  5. Submit for approval

Approval Process

StatusDescription
pendingSubmitted, awaiting admin review
approvedReady to use for sending SMS
rejectedNot approved (reason provided)

Note: Approval typically takes 24-48 hours. You will receive an email when your sender ID is approved or rejected.

Using Sender IDs in API

Include the senderId field in your API requests:

{
  "senderId": "MyCompany",
  "phone": "233200000000",
  "message": "Hello from MyCompany!"
}

Restrictions

Certain sender IDs are restricted or prohibited:

  • Names impersonating government agencies
  • Names impersonating banks or financial institutions
  • Names impersonating emergency services
  • Trademarked names without authorization
  • Offensive or misleading names

API: List Sender IDs

Get all your sender IDs:

GET /sender-ids

Response

{
  "success": true,
  "sender_ids": [
    {
      "id": "sid_123",
      "name": "MyCompany",
      "status": "approved",
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "sid_456",
      "name": "AlertSys",
      "status": "pending",
      "created_at": "2026-03-01T14:30:00Z"
    }
  ]
}

Error: Unapproved Sender ID

If you try to send with an unapproved sender ID:

HTTP/1.1 400 Bad Request
{
  "success": false,
  "error": "Sender ID 'NewBrand' is not approved. Please use an approved sender ID."
}