Skip to main content
DEVELOPER HUB

BulkSMS API Documentation

Integrate SMS, WhatsApp, Voice OTP, and Network APIs into your application in minutes. Highly reliable SDKs and low-latency REST API.

GET /v1/account

Authentication

BulkSMS API authenticates your requests using secret API keys sent in the request headers. All API requests must be performed over secure HTTPS connection.

Required Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
curl -X GET https://api.smsala.com/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY"
POST /v1/messages

SMS API

Send short text messages and verification alerts (2FA/OTP) directly to any mobile network in Brazil through Tier-1 routes.

Request Parameters

FieldTypeRequiredDescription
tostringYesRecipient phone number in international format (E.164), e.g., +971501234567.
fromstringYesSender ID displayed to the recipient. Up to 11 alphanumeric characters.
textstringYesThe message body text. Maximum 160 characters per standard segment.
curl -X POST https://api.smsala.com/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "from": "YourBrand",
    "text": "Your OTP code is 123456"
  }'
POST /v1/whatsapp/messages

WhatsApp API

Send conversational messages using Meta's Official WhatsApp Business API. Populate pre-approved message templates with variables for contextual utility.

Request Parameters

FieldTypeRequiredDescription
tostringYesRecipient phone number in international format (E.164), e.g., +971501234567.
templatestringYesName of the pre-approved WhatsApp template in Meta's Business Suite.
languagestringYesLanguage locale code of the template (e.g., 'en', 'pt_BR').
paramsstring[]NoOrdered array of string values to populate dynamic placeholders in your template.
curl -X POST https://api.smsala.com/v1/whatsapp/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "template": "otp_verification",
    "language": "en",
    "params": ["123456"]
  }'
POST /v1/verify/send & /check

Verify API (OTP)

Securely generate and check multi-factor verification codes (OTP). The Verify API manages token generation, lifetimes, state validation, and fallback logic automatically.

1. Request OTP Code

FieldTypeRequiredDescription
tostringYesRecipient phone number in international format (E.164), e.g., +971501234567.
channelstringYesDelivery channel: 'sms' or 'whatsapp'.
codeLengthnumberNoOTP code character length. Allowed values: 4 or 6. Default: 6.

2. Check OTP Code

FieldTypeRequiredDescription
tostringYesRecipient phone number in international format (E.164), e.g., +971501234567.
codestringYesThe numeric verification code input by the end user.
# 1. Send OTP
curl -X POST https://api.smsala.com/v1/verify/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "channel": "sms",
    "codeLength": 6
  }'

# 2. Check OTP
curl -X POST https://api.smsala.com/v1/verify/check \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "code": "482910"
  }'
POST /v1/network/sim-swap

Network APIs

Audit real-time carrier telemetry data. Prevent cellular-identity hijacking and Pix transaction fraud by querying recent SIM card modifications (SIM Swap).

Request Parameters

FieldTypeRequiredDescription
tostringYesMobile phone number in international format (E.164) to audit.
maxAgeHoursnumberNoTime window threshold in hours to check for a SIM Swap history. Default: 24.
curl -X POST https://api.smsala.com/v1/network/sim-swap \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+971501234567",
    "maxAgeHours": 24
  }'