API Reference - SMS API

Overview

The Hubtel SMS API is for businesses who are looking for a simple and easy way to integrate SMS functionalities into their applications. It is a highly-available API that sends millions of messages per day. With this API, you can easily send:

  1. Simple/Batch Messages to individuals or groups of people(batch).
  2. Personalized Messages to individuals or groups of people (batch).

The reference provides an overview of the Hubtel SMS API endpoints for interacting
programmatically within your application.

Getting Started

First, you need to hold a Hubtel Merchant Account to be able to use the Hubtel Sales API.
If you already have a Hubtel account, then skip to Step 2.

Step 1: Create a Hubtel Account
Step 2: Have the Account Verified and approved.

Authentication

For this API, there is only one method of authentication:

  1. SMS API KEYS

You need to authenticate every POST SMS request you make to any Hubtel SMS API using BasicAuth. Authenticate by encoding your username (clientID) and password (clientsecret) to Base64 HTTP Basic Authorization given in the formula below:

Authorization: Basic {base64_encode(clientId:clientsecret)}

A Base64 encoding of your API keys should have a similar Authorization header appear like this:
Basic a2hlcW2sb3U6bWdhtHd9YW8=. Try sample basic auth encoding here.

Login to your Hubtel account and click here to generate your API ID and API Key(s).

Integration Endpoints

The Hubtel SMS API allows you to integrate multiple SMS functionalities into your
applications. This document focuses on:

  • Simple Messaging: Send messages to individuals using POST and GET.
  • Batch Simple Messaging: Send simple messages to a group of people.
  • Batch Personalized Messaging: Send personalized messages to a group of people.
  • Message Status Check: Check the status of a message with messageId or batchId.