Developer Documentation

REST API Docs

All endpoints below use your branded domain. Clients only see your brand, your URL, and their own API key.

Overview

This API is designed for resellers and client integrations. All requests should be made to your branded API domain: https://sms.ummahhostbd.com/api/v1.

Base URL
https://sms.ummahhostbd.com/api/v1
Response Format
JSON
Authentication

Send your API key with any one of these methods.

Method Example
Form / Query api_key=YOUR_API_KEY
Header X-API-Key: YOUR_API_KEY
Bearer Token Authorization: Bearer YOUR_API_KEY
Send SMS
POST https://sms.ummahhostbd.com/api/v1/sms/send
Parameter Required Description
api_key Yes Your assigned API key
to Yes One or multiple recipient numbers separated by commas, format 8801XXXXXXXXX
message Yes The SMS content
sender_id No Approved sender ID for masking SMS
schedule_time No Schedule time in YYYY-MM-DD HH:MM:SS format
campaign_id No Optional campaign tracking identifier
Delivery Report
GET https://sms.ummahhostbd.com/api/v1/sms/report/{request_id}

Use the request ID returned after sending SMS. Include your API key using query, header, or bearer token authentication.

Check Balance
GET https://sms.ummahhostbd.com/api/v1/user/balance

Returns the current available SMS balance for the API key that was used in the request.

Error Codes
Code Meaning
400 Bad request (missing or invalid parameter)
401 Unauthorized (invalid API key)
403 Access forbidden
404 Resource not found
429 Too many requests (rate limit exceeded)
500 Internal server error
Code Examples
cURL
curl -X POST https://sms.ummahhostbd.com/api/v1/sms/send \
  -d "api_key=YOUR_API_KEY" \
  -d "to=8801700000000" \
  -d "message=Hello from Ummah Host BD SMS"
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://sms.ummahhostbd.com/api/v1/sms/send');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
    'api_key' => 'YOUR_API_KEY',
    'to' => '8801700000000',
    'message' => 'Hello World!'
]);
Node.js
const axios = require('axios');
axios.post('https://sms.ummahhostbd.com/api/v1/sms/send', {
  api_key: 'YOUR_API_KEY',
  to: '8801700000000',
  message: 'Hello Ummah Host BD SMS'
});
Support

For onboarding, sender ID approval, or integration support, contact your service administrator.

Support Email: support@ummahhostbd.com