Aatrox Communications SMS RESTful API (V2)

Below is a comprehensive guide for the Aatrox Communications SMS RESTful API. This guide covers configuration details, endpoint usage, authentication, error handling, and examples. It is designed to help partners and developers integrate SMS functionality into their applications.

Overview

The Aatrox Communications SMS API enables you to send, receive, and manage SMS messages through a secure and robust RESTful service. The API supports additional features such as appending disclaimers to messages.

Key Features:

• Send SMS: Standard SMS sending with simple parameters.
• Send SMS with Disclaimer: Automatically appends a disclaimer based on the sender's phone number.
• Receive SMS: Retrieve incoming messages.
• Retrieve Message Details & History: Get details of individual messages and list message IDs with timestamps.
• Bulk Messaging: Send messages to multiple recipients in one request.

Authentication

All API endpoints require Bearer Token authentication. To obtain your token, please contact our support team at support@aatroxcommunications.com.au to verify your mobile number. Once verified, you will receive your token through a secure login process. Be sure to include this valid token in the Authorization header of your HTTP requests:

You must include a valid token in the Authorization header of your HTTP requests:

Authorization: Bearer YOUR_TOKEN_HERE

This header is required for every endpoint. Failure to provide a valid token will result in a 401 Unauthorized response.

Server Configuration

• Base URL: https://api.smsaatrox.com.au
• API Version: 2.0.0

All API endpoints are prefixed with /api/v2/.

Endpoints Overview

Sending SMS

Single Message

• Endpoint: POST /api/v2/sms/send

Request Example:

{  "from": "SenderNumber",  "to": "RecipientNumber",  "text": "Your message text here." }

SMS with Disclaimer

Send SMS messages with predefined disclaimers appended automatically.

• Endpoint: POST /api/v2/sms/send/disclaimer

Request Example:

{  "from": "SenderNumber",  "to": "RecipientNumber",  "text": "Your message text here." }

Retrieve SMS Details

• Endpoint: GET /api/v2/sms/{id}

Response Example:

{  "to_addr": "RecipientNumber",  "from_addr": "SenderNumber",  "status": "delivered",  "status_at": "Timestamp",  "segment_count": 1 }

Retrieve Received SMS

• Endpoint: GET /api/v2/sms/receive

Query Parameters:

• to (required): Recipient number
• from (optional): Sender number for filtering

Send Bulk SMS

• Endpoint: POST /api/v2/sms/send/bulk

Request Example:

{  "from": "SenderNumber",  "to": ["RecipientNumber1", "RecipientNumber2"],  "text": "Your message here." }

Response Codes

• 200 OK: Success
• 400 Bad Request: Invalid parameters
• 401 Unauthorized: Authentication failed
• 500 Internal Server Error: Server-side issue

Security and Best Practices

• Keep your API token secure.
• Always use HTTPS.
• Request Rotate API tokens regularly.
• Validate user inputs strictly.

For more detailed guide see below:
https://docs.smsaatrox.com.au/

Conclusion

The Aatrox Communication SMS API offers a wide range of features for sending and managing SMS messages, from standard and disclaimer-appended messages to bulk messaging and message history retrieval. This guide provides a detailed reference for developers to effectively configure and integrate the API into their applications. For further questions or support, refer to the API documentation or contact the development team.