textsms24← Back to home
Home› Documentation
TEXTSMS24 DOCUMENTATION

From first install
to first send.

Install the Android gateway, connect your SIM, then use the API from your backend to send messages and verify delivery.

API v15 minute setup
✓

Your messages go through your own SIM. The phone must be on, connected to the internet, and have cellular service and SMS credit to send.

01

Before you begin

What you'll need for setup.

  • ✓ An Android phone running Android 8.0 or later.
  • ✓ An active SIM with SMS service and a working data connection.
  • ✓ Your TextSMS24 server URL.
  • ✓ A backend where you can securely store your API key.
02

Install the Android app

Install TextSMS24 on the phone that will send messages.

  1. 1
    Download the app

    Use the official APK download link supplied by your administrator. The APK isn't hosted in this project yet; ask your administrator for the official download.

  2. 2
    Build for your server

    The Android app's server URL is set at build time. Configure BASE_URL in android/local.properties and rebuild the APK for your server.

  3. 3
    Open the app and register

    Enter a gateway name and phone number, then grant the SMS, phone, and notification permissions Android requests.

  4. 4
    Keep the gateway available

    Allow notifications and exempt TextSMS24 from battery optimization so Android can keep its background service active.

03

Register your device

The app registers the phone and maintains its gateway connection.

After registration, the admin dashboard lists the device and its latest network and battery status. Keep the device powered, connected to the internet, and covered by a working SIM plan.

04

Create an API key

Generate a key scoped to the connected SIM.

Open the app's Settings screen and choose Generate API key for this SIM. Copy it once, then save it as a secret on your backend. Generating a new key for that SIM revokes its previous key.

⌑ Keep keys private. Never put an API key in browser code, a mobile client, or a public repository.
05

Send your first SMS

Use a bearer key and JSON request body.

POSThttps://smsgateway.samparkamart.in/api/v1/sms/send
curl -X POST "https://smsgateway.samparkamart.in/api/v1/sms/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"+919876543210","message":"Hello from TextSMS24"}'

A successful request returns HTTP 202 Accepted and a message ID with status queued. Use an international phone number.

06

Send a verification OTP

Pass a six digit code instead of a custom message.

{
  "to": "+919876543210",
  "otp": "546321"
}

Provide either message or otp, never both. OTP values must contain exactly six digits. TextSMS24 creates the body Your verification otp is 546321.

07

Check message status

Use the message ID returned by the send endpoint.

GEThttps://smsgateway.samparkamart.in/api/v1/sms/{message_id}/status

The status response includes the recipient, current status, attempts, and timestamps. Message states include queued, sent, delivered, and failed.

✦
That's the whole flow.

Build something good with it.

Back to TextSMS24 →