Introduction

Welcome to the HudumaSMS RESTful API documentation! This comprehensive guide will walk you through the process of integrating our robust and versatile RESTful APIs into your applications.

About HudumaSMS

HudumaSMS is part of the HudumaCloud family of products, offering powerful bulk SMS messaging capabilities for businesses and developers. Our API allows you to programmatically send SMS messages, manage contacts, track delivery status, and much more.

Getting Started

Before you can start using the HudumaSMS API, you'll need to complete the following steps:

1. Create a HudumaCloud Account

HudumaSMS is accessible through the HudumaCloud platform. To get started, you must first create a HudumaCloud account:

1. Visit HudumaCloud Sign Up to create your account
2. Complete the registration process by providing your details
3. Verify your email address

2. Access HudumaSMS

Once you have created your HudumaCloud account:

1. Log in to your HudumaCloud dashboard
2. Navigate to the "Products" section
3. Select "HudumaSMS" from the available products
4. Complete any product-specific setup requirements

3. Register Your Application on the Developer Portal

To use the HudumaSMS API, you must register your application on the Huduma Developers Portal:

1. Visit the Huduma Developers Portal
2. Log in with your HudumaCloud credentials
3. Navigate to "My Applications" and select "Add Application"
4. Provide your application details, including name and description and callback url
5. Submit your application for approval

4. Obtain Your API Credentials

After your application is approved:

1. Generate Your API Keys

   • After registration, open your app's details page.
   • Click the "Generate Keys" button.
   • A form will appear — choose your token expiry time.
   • The App Secret will be filled in automatically, so no need to enter it manually.

2. Get Your Credentials
   Once you submit the form, you’ll receive:

   • Access Token – used to make API requests. Add it to the X-Huduma header.
   • Public Key – used to verify signed API responses.

Authentication

All API requests must include your API token in the header:

X-Huduma: Bearer {your_api_token}

Base URL

All API requests should be made to the following base URL:

https://sms-api.huduma.cloud/api/v3

API Versioning

The current version of the HudumaSMS API is v3. When making requests, ensure you use the correct endpoint version to avoid compatibility issues.

Rate Limits

The HudumaSMS API implements rate limiting to ensure fair usage across all customers.

Please ensure you're familiar with our Terms of Service and Acceptable Use Policy before using the API.