Skip to Content

Introduction

Overview of the SMS Pro Developer Platform, core messaging capabilities, integration protocols, and data formats.

View Markdown (.md)

Welcome to the SMS Pro Developer Platform. SMS Pro delivers carrier-grade direct telecommunications routing across Ghana and West Africa (supporting MTN, Telecel, and AT networks) with sub-second delivery latencies, zero-knowledge verification primitives, and enterprise reliability.

Whether you are dispatching mission-critical one-time passwords (OTPs), sending real-time transactional payment receipts, launching high-volume localized marketing campaigns, or automating customer surveys, our developer APIs provide a robust, modern foundation for your communication stack.


Core Capabilities

The SMS Pro platform exposes an extensive suite of public REST endpoints designed for speed, resilience, and developer ergonomics:


Integration Architecture

SMS Pro is built upon standard web protocols to integrate cleanly into any language, framework, or cloud environment:

Protocol & ConventionSpecification & Usage
TransportSecure HTTPS (TLS 1.2 or 1.3 required on all inbound and outbound requests).
API ArchitectureStandard RESTful design with predictable resource URLs and HTTP verbs (GET, POST, PUT, DELETE).
Data FormatRequest and response payloads are formatted strictly as application/json with UTF-8 encoding.
Error HandlingRFC 7807 Problem Details (application/problem+json) with structured error codes and trace IDs.
IdempotencySupported on all mutating POST endpoints via the Idempotency-Key header to safely retry requests without duplicates.
WebhooksOutbound HTTP POST notifications signed with a SHA-256 HMAC digest in the X-SmsPro-Signature header.

API Versioning

All SMS Pro developer endpoints follow structured URI versioning:

https://api.smspro.com/api/v1/public/...
  • Path prefix: /api/v1/public/ guarantees backward compatibility.
  • Breaking changes: Breaking modifications (such as removing fields or altering required parameters) are never applied without a new major version prefix (e.g. /api/v2/).
  • Additive enhancements: New optional request parameters, additional webhook events, or extra fields in response objects are introduced non-destructively within the existing version.

What Developers Can Build

With the SMS Pro platform, engineering teams frequently build:

  1. Authentication Workflows: Secure two-factor authentication (2FA), passwordless magic logins, and password reset flows over prioritized telco channels.
  2. Fintech & Banking Notifications: Real-time transaction alerts, instant debit/credit receipts, and compliance audit notifications.
  3. Logistics & Delivery Updates: Automated dispatch milestones, courier arrival notifications, and live tracking short links.
  4. Healthcare & Appointment Reminders: Scheduled reminders that reduce missed appointments and support interactive SMS confirmation replies.
  5. Customer Engagement Campaigns: Personalized, segmented bulk messaging with custom sender IDs for promotions, announcements, and emergency notices.

Next Steps

To begin building on SMS Pro:

Review the Prerequisites

Check environment requirements, telecom standards, and supported tooling in Prerequisites.

Register on the SMS Pro Platform

Set up your account on the SMS Pro console as outlined in Create an Account.

Enable the Developer Environment

Unlock developer features and generate scoped API keys in Developer Environment & API Keys.

On this page