API Specification

Version 1.02 | May 18, 2025

General Information

Base URL

https://[hostname]/api
Security Requirement: All connections must be established using TLS 1.3. Requests using older versions (TLS 1.2 or below) will be rejected.

Required Headers

Header Key Value Description
X-API-KEY [your-api-key] Required for authentication.
Content-Type application/json Required for all body-based requests.

SMS Service Endpoints

POST

/sms

Type: single

Sends SMS to a single mobile number.

Request Body 

{
    "api_type": "single",
    "message": "Hello, this is a test message.",
    "sender_id": "REPLYX",
    "mobile_no": "6591234567"
}

Success Response

{ "reference": "guid-string" }
POST

/sms

Type: single_extended

Sends SMS with remarks and whether to reject if mobile number is in the unsub list.

Request Body 

{
    "api_type": "single_extended",
    "message": "Your appointment is confirmed.",
    "sender_id": "REPLYX",
    "mobile_no": "6591234567",
    "internal_remarks": "Appt-Ref-123",
    "is_reject_unsub": false
}

Success Response

{ "reference": "guid-string" }
POST

/sms

Type: batch_invalid_remove

Sends a batch of messages while automatically filtering invalid mobile numbers.

Request Body 

{
    "api_type": "batch_invalid_remove",
    "original_message": "Hello @@@@@, your values are @X@, @Y@ and @Z@.",
    "sender_id": "REPLYX",
    "mobile_nos": ["6591234567", "6587654321"],
    "names": ["John", "Henry"],
    "xs": ["Gold", "Silver"],
    "ys": ["West", "East"],
    "zs": ["Apple", "Orange"]
}

Success Response

{ "reference": "guid-string" }
POST

/sms

Type: batch_invalid_unsub_remove

Sends a batch of messages while automatically filtering invalid and unsub mobile numbers.

Request Body 

{
    "api_type": "batch_invalid_unsub_remove",
    "original_message": "Hello @@@@@, your values are @X@, @Y@ and @Z@.",
    "sender_id": "REPLYX",
    "mobile_nos": ["6591234567", "6587654321"],
    "names": ["John", "Henry"],
    "xs": ["Gold", "Silver"],
    "ys": ["West", "East"],
    "zs": ["Apple", "Orange"]
}

Success Response

{ "reference": "guid-string" }

HTTP Status Codes

Status Description
200 OK Request successful. The reference GUID is returned.
401 Unauthorized API Key is missing or invalid. Check X-API-KEY header.
400 Bad Request Missing required parameters or unknown api_type. Check detail field.