Frequently Asked Question

SMS - Send SMS Text Messages

Last Updated 7 days ago

SMS API

Overview

The SMS API allows sending text messages to specified phone numbers. It sanitises the message content, limits the message length, and uses an internal SMS gateway to send the messages.

Version

1.002

Endpoint

/v2/sms.php

Authentication

This API requires authentication using an API key. The key should be passed in the HTTP_X_API_KEY header.

Request Parameters

Parameter	Type	Description
number	string	The recipient's phone number (required, max 20 characters)
message	string	The SMS message content (required, max 155 characters)

Response

The API returns a JSON object with the following structure:

Field	Type	Description
status	string	"success" if the message was sent, or an error message
message	string	A description of the action taken (only if successful)
feedback	string	The response from the SMS gateway (only if successful)

Example Response (Success)


{
  "status": "success",
  "message": "SMS sent to 1234567890 : Hello, this is a test message",
  "feedback": "Message queued for delivery"
}

Example Response (Error)


{
  "status": "500 : Invalid number or message"
}

Error Handling

If the number is not numeric or the message is empty: {"status": "500 : Invalid number or message"}
If there's an authentication error: {"status": "[validation status]"}

Notes

The API sanitises the message by replacing newlines, carriage returns, and tabs with spaces.
Multiple spaces in the message are reduced to single spaces.
The message is trimmed and truncated to a maximum of 160 characters.

Security

Ensure that the API key is kept secure and not exposed in client-side code.

Limitations

The API is limited to sending messages of 160 characters or less.
The API doesn't validate the format of the phone number beyond checking if it's numeric, a bad number will still count as one credit.