🕊ïļ
ðŸŠķ
âœĻ
🍂
🍁
ðŸŠķ
🍂
🍁
ðŸŠķ

Developer REST API Documentation

Integrate BulkSMS Pro SMS, Voice, WhatsApp, Sender IDs, and Phonebook capabilities into your apps seamlessly.

Manage API Keys
API Endpoint Base URL
https://speedboltsms.top/api/index.php
Header Auth: X-API-Key
Authentication & Headers

All REST API requests require an active API Key. You can generate and manage keys in your API Keys Dashboard.

Pass your key via HTTP Header (Recommended) or URL Query Parameter:

  • Header: X-API-Key: YOUR_API_KEY
  • Query Parameter: https://speedboltsms.top/api/index.php?endpoint=balance&key=YOUR_API_KEY
GET Check Wallet & Credits Balance
?endpoint=balance

Retrieve real-time wallet balance and remaining credits for SMS, WhatsApp, and Email.

Example cURL Request:
curl -X GET "https://speedboltsms.top/api/index.php?endpoint=balance" \
  -H "X-API-Key: YOUR_API_KEY"
JSON Response (200 OK):
{
  "status": "success",
  "data": {
    "balance": "466.50",
    "sms_credits": "500.00",
    "whatsapp_credits": "100.00",
    "email_credits": "1000.00"
  }
}
POST Send SMS / Bulk SMS Campaign
?endpoint=send_sms

Send transactional or promotional SMS messages to one or multiple recipients.

Request Body Parameters:
ParameterTypeRequiredDescription
senderstringRequiredApproved Sender ID (e.g. MyCompany)
messagestringRequiredMessage content to broadcast
recipientsarray / stringRequiredArray of phone numbers e.g. ["0240000000", "0200000000"]
Example cURL Request:
curl -X POST "https://speedboltsms.top/api/index.php?endpoint=send_sms" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": "Jima Shop",
    "message": "Your OTP code is 948102. Valid for 5 minutes.",
    "recipients": ["0240000000"]
  }'
JSON Response (200 OK):
{
  "status": "success",
  "message": "SMS queued successfully",
  "data": {
    "campaign_id": 15,
    "recipients": 1,
    "segments_per_sms": 1,
    "credits_used": 1
  }
}
POST Trigger Voice Broadcast Call
?endpoint=send_voice

Broadcast Text-to-Speech or pre-recorded audio calls to phone numbers.

Request Body Parameters:
ParameterTypeRequiredDescription
recipientsarray / stringRequiredTarget phone numbers
messagestringOptionalText script for Text-to-Speech conversion
audio_urlstringOptionalDirect URL to hosted MP3/WAV audio file
Example cURL Request:
curl -X POST "https://speedboltsms.top/api/index.php?endpoint=send_voice" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": ["0240000000"],
    "message": "Hello, this is an urgent account notification broadcast."
  }'
POST Send WhatsApp Message
?endpoint=send_whatsapp

Dispatch instant WhatsApp messages to customer mobile numbers.

Example cURL Request:
curl -X POST "https://speedboltsms.top/api/index.php?endpoint=send_whatsapp" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "0240000000",
    "message": "Hello! Your store order #8491 has been dispatched."
  }'
GET List Approved Sender IDs
?endpoint=sender_ids

List all custom Sender IDs registered under your account along with approval status.

curl -X GET "https://speedboltsms.top/api/index.php?endpoint=sender_ids" \
  -H "X-API-Key: YOUR_API_KEY"
GET Get Campaign Delivery Report
?endpoint=delivery_report&campaign_id=15

Retrieve detailed delivery metrics and message logs for a queued campaign ID.

curl -X GET "https://speedboltsms.top/api/index.php?endpoint=delivery_report&campaign_id=15" \
  -H "X-API-Key: YOUR_API_KEY"
API Response & Error Codes
HTTP CodeStatusDescription
200 OKsuccessRequest completed successfully.
400 Bad RequesterrorMissing required parameters or insufficient wallet credits.
401 UnauthorizederrorInvalid, missing, or disabled API key.
403 ForbiddenerrorAccount suspended or global API access disabled.
404 Not FounderrorUnknown endpoint or campaign ID not found.
405 Method Not AllowederrorIncorrect HTTP method used (e.g. GET instead of POST).