Copy page

SMS

SMS Sending Flows

Updated: 2025-11-25 - Extracted from Getting Started and updated to match v2 API

This guide details the flows for sending Transactional (Single) and Bulk (Batch) SMS messages using the Tech231 Platform API.

Transactional SMS

Transactional SMS messages are sent individually and are typically triggered by user actions (e.g., OTPs, notifications).

Endpoint

POST /api/v2/sms/queue

Request

Headers:

• Authorization: Bearer <YOUR_ACCESS_TOKEN>
• Content-Type: application/json

Body:

Code
{
  "recipient": "231XXXXXXXXX",
  "message": "Your OTP is 123456",
  "sender": "YourSenderID",
  "batchId": "optional-uuid"
}

Response

Returns 202 Accepted with the SMS details.

Code
{
  "messageId": "uuid",
  "tenantId": "string",
  "senderId": "string",
  "recipient": "string",
  "content": "string",
  "status": "Queued",
  "createdAt": "2025-11-25T10:00:00Z"
}

Bulk SMS (Batch Processing)

Bulk SMS allows you to send large volumes of messages efficiently using Batches. The flow consists of three steps: Creating a batch, adding messages, and starting the batch.

Step 1: Create a Batch

Create a new batch to hold your messages.

Endpoint: POST /api/v2/batch

Body:

Code
{
  "name": "Marketing Campaign",
  "description": "November Promo",
  "maxConcurrency": 10
}

Response: 201 Created with the batchId.

Step 2: Add Messages

You can add messages individually, in bulk, or as a broadcast (same message to multiple recipients).

Add Bulk Messages

Use this endpoint to add multiple messages.

Endpoint: POST /api/v2/batch/{batchId}/messages/bulk

Body:

Code
{
  "receivers": ["231XXXXXXXXX", "231YYYYYYYYY"],
  "content": "Hello, this is a message for you.",
  "senderId": "YourSenderID",
  "metadata": {
    "campaignId": "123"
  }
}

Add Broadcast Message

Use this endpoint to send the exact same message content to multiple recipients.

Endpoint: POST /api/v2/batch/{batchId}/broadcast

Body:

Code
{
  "receivers": ["231XXXXXXXXX", "231YYYYYYYYY"],
  "content": "Broadcast message to all.",
  "senderId": "YourSenderID"
}

Step 3: Start Processing

Once messages are added, start the batch processing.

Endpoint: POST /api/v2/batch/{batchId}/start

Response: 200 OK with updated batch status.

Checking Batch Status

Endpoint: GET /api/v2/batch/{batchId}

Returns the current status, counts (pending, success, failure), and other details.