SMS Flare — Public Documentation

Public Documentation: These examples use template URLs. Once you deploy your own instance, you can find your real Worker URL pre-filled in your private dashboard docs.

Getting Started

SMS Flare turns any Android phone into an SMS gateway. Your dashboard sends jobs to a paired device, which sends the actual SMS messages via the phone's SIM card. No carrier API required.

              Step 1

Deploy

Deploy the backend Worker and dashboard.

              Step 2

Pair device

Install the Android app and scan the QR code.

              Step 3

Send SMS

Start sending via API or dashboard.

All API requests should be sent to your Worker URL. These examples use https://your-worker.workers.dev as a placeholder.

Device Pairing

Each Android device must be paired before it can send SMS. Pairing creates a permanent device token the app uses to poll for jobs.

Install the SMS Flare Android app on the phone.
In your dashboard, go to Settings → API Keys and generate a pairing token.
Scan the QR code with the Android app.
The device will appear as online in the dashboard within 30 seconds.

Sending SMS

Dispatch messages programmatically via the REST API using your API key.

bash

curl -X POST https://your-worker.workers.dev/api/sms/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "+14155552671", "message": "Hello from SMS Flare!"}'

API Reference

All endpoints accept and return JSON. The base URL is your Worker's deployment URL.

SMS Endpoints

POST /api/sms/send API Key

Send a single SMS message. The job is immediately assigned to an active device.

Request body

Field	Type	Description
`to`	string	Recipient phone number (E.164).
`message`	string	Message body (max 160 chars).

Full API documentation for all endpoints (Jobs, Devices, Auth) is available in your instance's internal dashboard docs.