Sending SMS

This guide explains how to send SMS messages using the SimpleText API. SMS is the core service that simpletext provides, allowing you to send transactional messages, notifications, and alerts to your users.

SMS messages are sent using the POST /sms endpoint. You can send messages using the SimpleText client package or directly using cURL. All phone numbers are expected to be in E.164 format (e.g., if your phone number is +1-123-456-7890, you would send it as +11234567890).

Using the SimpleText Package

Then, use the sendSMS method to send a message:

import {simpletext} from "@/lib/simpletext"; // or wherever you put your client!
import {SendSMSParams} from "@simpletext/client";
 
export async function sendSMS() {
  const params: SendSMSParams = {
    to: "+11234567890",
    message: "Hi, Ryland!",
  };
  try {
    const response = await simpletext.sendSMS(params);
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

Using cURL

You can also send SMS messages directly using cURL:

curl -X POST https://api.simpletext.dev/sms \
-H "Content-Type: application/json" \
-d '{
    "to": "+11234567890",
    "message": "Hi, Ryland!",
    "SIMPLETEXT_SECRET": "your-secret-here",
    "SIMPLETEXT_APP_ID": "your-app-id-here"
}'

Response

Both methods will return a response in the following format:

    {
      "success": true,
      "message": "SMS sent successfully",
      "requests_remaining_today": 123 // number of requests remaining for the day
    }