Documentation

Get up and running with SMSTunnel in 5 minutes:

Android App Requirements

• Android 7.0 (Nougat) or higher
• Active SIM card with SMS capability
• Stable internet connection (WiFi or mobile data)
• SMS permissions granted

Download Options

All API requests require authentication using your API key:

curl -X POST https://smstunnel.io/api/v1/sms/send \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber": "+40712345678", "message": "Hello!"}'

Initial Configuration

1. Install the app - Download and install the SMSTunnel APK on your Android device.
2. Grant permissions - Allow SMS and notification permissions when prompted.
3. Scan QR code - Go to your dashboard and scan the device pairing QR code.
4. Enable background service - Toggle the service to "Running" in the app.
5. Disable battery optimization - Follow the in-app prompt to ensure reliable background operation.

The app requires the following permissions:

For reliable SMS delivery, the app runs a background service. Here's how to ensure it stays active:

Battery Optimization

Most Android phones aggressively kill background apps. To prevent this:

1. Go to Settings > Apps > SMSTunnel
2. Tap "Battery" or "Battery optimization"
3. Select "Don't optimize" or "Unrestricted"

Basic SMS

POST /api/v1/sms/send
Content-Type: application/json
X-API-Key: your_api_key

{
  "phoneNumber": "+40712345678",
  "message": "Your verification code is: 123456"
}

Response

{
  "success": true,
  "messageId": "msg_abc123xyz",
  "status": "queued"
}

See the API Reference for all available parameters and options.

SMSTunnel provides a dedicated endpoint for sending 2FA/OTP codes with optimized delivery:

POST /api/v1/sms/2fa
Content-Type: application/json
X-API-Key: your_api_key

{
  "phoneNumber": "+40712345678",
  "code": "123456",
  "template": "Your login code is: {code}. Valid for 5 minutes."
}

Receive real-time notifications about SMS delivery status via webhooks (Pro plan):

Setup

1. Go to Dashboard > Settings > Webhooks
2. Add your endpoint URL (must be HTTPS)
3. Select events to receive (sent, delivered, failed)
4. Save and copy the signing secret

Webhook Payload

{
  "event": "sms.delivered",
  "messageId": "msg_abc123xyz",
  "phoneNumber": "+40712345678",
  "status": "delivered",
  "timestamp": "2025-01-02T10:30:00Z"
}

Install the SMSTunnel WordPress plugin to send SMS directly from your WordPress site:

Installation

1. Download the plugin from your dashboard
2. Go to Plugins > Add New > Upload Plugin
3. Upload the ZIP file and activate
4. Go to Settings > SMSTunnel
5. Scan the QR code with your phone or enter API key manually

See the Integrations page for more details and additional plugins.

Send automatic SMS notifications for WooCommerce orders:

Available Notifications

• New Order - Notify admin when a new order is placed
• Order Confirmation - Send confirmation to customer
• Order Status Change - Notify on processing, shipped, completed
• Low Stock Alert - Alert when products are running low

Configure message templates with placeholders like {order_id}, {customer_name}, {total}.

Receive SMS notifications when someone submits a Contact Form 7 form:

Setup

1. Install both SMSTunnel and SMSTunnel CF7 plugins
2. Go to Contact > Your Form > SMSTunnel tab
3. Enable SMS notification
4. Enter recipient phone number
5. Customize message template using form tags

Template Example