SMSDESK Developer Portal

📨 SMS API

Base URL: https://{host}

Send SMS messages, retrieve delivery reports, view logs, and manage scheduled messages.

Key Features:

• Send SMS: Single or bulk message sending
• Delivery Reports: Real-time delivery status
• Message Logs: View sent message history
• Scheduled Messages: Queue messages for future delivery
• Message Preview: Validate before sending

Authentication:

Authorization: YOUR_API_KEY

View SMS API Documentation

📱 USSD API

Base URL: https://{host}

Build interactive USSD applications with session management and menu navigation.

Key Features:

• USSD Relay: Receive and respond to USSD requests
• Session Management: Track user sessions
• Menu Navigation: Build interactive menus
• Webhooks: Real-time USSD event notifications
• Testing Tools: Simulate USSD sessions

Authentication:

Authorization: YOUR_API_KEY

View USSD API Documentation

SMPP Server

Protocol: SMPP v3.4

Connect your system via SMPP protocol for sending and receiving SMS messages.

Key Features:

• Send SMS: SUBMIT_SM PDU support
• Receive SMS: DELIVER_SM PDU support
• Bind Types: TRANSMITTER, RECEIVER, TRANSCEIVER
• Delivery Reports: Optional DLR support
• Session Management: Automatic keepalive

Authentication:

System ID: your-email@example.com
Password: first 8 chars of API key

View SMPP Server Documentation

Error Codes Reference

Centralized Error Handling

Comprehensive error code documentation for all SMSDESK APIs and SMPP operations.

Categories:

• Backend Errors: AUTH_xxx, VAL_xxx, SYS_xxx
• SMPP Protocol: ESME_xxx (standard codes)
• SMPP Custom: CONN_xxx, SUB_xxx
• Error Types: Error, Warning, Information

Example Response:

{
  "error": {
    "code": "AUTH_001",
    "message": "Invalid API key"
  }
}

View Error Codes Reference

� Web-Based Subscription Management

NEW: Public API - No Auth Required

Allow users to opt-in/opt-out via web links - perfect for alphanumeric sender IDs that cannot receive SMS replies.

Key Features:

• Public Endpoints: No authentication required for user convenience
• Beautiful UI: Mobile-responsive confirmation pages
• Alphanumeric Support: Solve the "can't reply to SchoolSMS" problem
• URL Shortening: Save SMS characters with short links
• Instant Processing: Real-time database updates

Example Endpoints:

Opt-Out: /sms/2/messages/subscription/{clientid}/opt/out/{mobile}
Opt-In:  /sms/2/messages/subscription/{clientid}/opt/in/{mobile}

View Subscription API

�📡 Webhooks

Security: HMAC-SHA256 Signed

Receive real-time notifications for delivery receipts and opt-out events with secure HMAC-SHA256 signatures.

Key Features:

• Delivery Receipts (DLR): Real-time message status updates
• Opt-out Events: STOP keyword notifications
• HMAC-SHA256: Cryptographic signature verification
• Retry Logic: Automatic retry with exponential backoff
• Idempotent: Safe to retry on failures

Signature Header:

X-Signature: sha256=<hmac-hash>

View Webhooks Documentation

🔧 Interactive API Reference

Format: OpenAPI 3.0 (Swagger)

Explore the live API definitions with interactive Swagger UI. Inspect request/response schemas, try endpoints directly from your browser, and generate code samples.

Key Features:

• Live Schema Explorer: All request/response models documented
• Try It Out: Send test requests directly from the UI
• Auto-Generated: Spec generated from actual server routes
• Deep Linking: Share direct links to specific endpoints

Available Specs:

SMS API:  /swagger/json (port 2019)
USSD API: /swagger/json (port 2020)

Open Swagger UI

Custom Integrations

Platform-specific endpoints: Pre-built integrations for third-party platforms

SMSDESK provides custom API endpoints that match the parameter names, authentication methods, and response formats of popular third-party platforms — no middleware required.

Available Integrations:

• SAP Connect: SAP ERP / Business One SMS sending
• WaitWhile: Queue & booking webhook receiver with SMS notifications
• Elixir Batch: Elixir-formatted batch SMS (legacy)
• WSDL / SOAP: SOAP web service for legacy systems

View Custom Integrations