openapi: 3.2.0 info: version: 2.0.1 title: Aatrox Communications SMS API description: > The Aatrox Communications API provides a streamlined, secure middleware platform to route and manage SMS messages, handle inbound notification webhooks, and configure privacy logging. servers: - url: 'https://api.smsaatrox.com.au' description: Production API Server (v2) components: securitySchemes: BearerAuth: type: http scheme: bearer description: Provide your unique account token to authorize messaging operations. tags: - name: Messaging description: Core endpoints for sending standard, disclaimer-appended, and bulk SMS campaigns. - name: Storage & Compliance description: Controls for data logging preferences and auditing exports. - name: Webhooks description: Inbound data streams. paths: /api/v2/sms/send: post: summary: Send a standard SMS description: > Send a text message securely to a single recipient. The gateway filters, trims, and normalizes phone numbers automatically to guarantee delivery. tags: - Messaging security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: from: type: string description: Your assigned sender phone number. to: type: string description: The target mobile phone number. text: type: string description: The content of your text message. required: - from - to - text responses: '200': description: Message successfully dispatched. content: application/json: schema: type: object properties: status: type: string example: success message: type: string example: SMS forwarded successfully data: type: object properties: id: type: string description: Unique tracking ID for the sent message. '400': description: Bad Request. Expecting a valid JSON payload with all required fields. '401': description: Unauthorized. Missing or invalid Bearer token. '500': description: Internal Server Error. /api/v2/sms/send/disclaimer: post: summary: Send SMS with an automated disclaimer description: > Maintains communication compliance by looking up a pre-configured legal or marketing disclaimer mapped to your sender number, appending it to your text body, and delivering it seamlessly. tags: - Messaging security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: from: type: string description: Your assigned sender phone number. to: type: string description: The recipient's mobile phone number. text: type: string description: The core message text (the disclaimer will be dynamically attached to the end). required: - from - to - text responses: '200': description: Disclaimer SMS successfully sent. content: application/json: schema: type: object properties: status: type: string message_id: type: string message: type: string data: type: object properties: id: type: string '400': description: Bad Request. Missing parameters or invalid layout. '401': description: Unauthorized token. '500': description: Internal Server Error. /api/v2/sms/send/bulk: post: summary: Send a bulk SMS campaign description: > Distribute a text message batch to multiple targets instantly. The target list can be supplied either as a JSON string array or a comma-separated string format. tags: - Messaging security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: from: type: string description: Your assigned sender phone number. to: oneOf: - type: array items: type: string description: An array of recipient phone numbers. - type: string description: A comma-separated list of recipient phone numbers. text: type: string description: Shared message body content to send to all contacts. required: - from - to - text responses: '200': description: Bulk campaign processing has concluded. content: application/json: schema: type: object properties: status: type: string example: completed results: type: array items: type: object properties: to: type: string status: type: string description: '"success" or "failure" for this specific recipient.' messageId: type: string description: Assigned unique tracking ID if the message succeeded. error: type: string description: Reason for failure, if applicable. '400': description: Invalid data payload format. '401': description: Unauthorized. '500': description: Internal Server Error. /api/v2/sms/send/Enablecontent: post: summary: Enable text logging retention description: > A privacy configuration endpoint. Opt-in to persistently index actual text string message contents linked with your sender address. This logging must be enabled if you intend to generate spreadsheets using our export system tool. tags: - Storage & Compliance security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: from: type: string description: Mobile number profile configuration to activate text tracking on. required: - from responses: '200': description: Content logging preference updated successfully to active. '401': description: Unauthorized security token. '500': description: Database write error. /api/v2/sms/send/DisableContent: post: summary: Disable text logging retention description: > Enforce a strict ephemeral data stance. Completely drops text record tracking values for your outbound address across message histories, leaving content strictly blank outside immediate routing workflows. tags: - Storage & Compliance security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: from: type: string description: Mobile number profile configuration to drop text tracking on. required: - from responses: '200': description: Content logging preference updated successfully to hidden. '401': description: Unauthorized security token. '500': description: Database write error. /api/v2/sms/send/exportcsv: post: summary: Export communication history report description: > Aggregates stored system databases, formatting tracked SMS log attributes into a robust structural spreadsheet document, and delivers it straight to your designated corporate inbox. tags: - Storage & Compliance security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: from: oneOf: - type: string description: Target phone number source to filter auditing data. - type: array items: type: string description: Array of phone number profiles to query simultaneously. email: type: string format: email description: Destination email address to send the generated analytical spreadsheet file to. required: - from - email responses: '200': description: Spreadsheet successfully built and delivered via email gateway. '400': description: Content logging has not been enabled on this target number configuration. '401': description: Unauthorized token credential validation. '500': description: Report packaging error or email delivery framework error. /api/v2/auto-responder/enable: post: summary: Enable SMS Auto Responder description: | Turn on an automatic SMS reply for your assigned number. Use the same Bearer token you already use for `/api/v2/sms/send`. You can also enable it by sending this SMS from your number to the same number: ```text Enable: Auto Responder Content: Hi, I'm away. Please call my office. Date start: 22/07/2026 Date end: 30/07/2026 ``` `Date start` and `Date end` are optional. tags: - Messaging security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: Your assigned SMS number. example: "+61480013822" content: type: string description: The reply message customers will receive. example: "Hi, I'm away. Please call my office." dateStart: type: string description: Optional start date in DD/MM/YYYY format. example: "22/07/2026" dateEnd: type: string description: Optional end date in DD/MM/YYYY format. example: "30/07/2026" required: - number - content examples: scheduled: summary: Enable for a date range value: number: "+61480013822" content: "Hi, I'm away from 22/07/2026 to 30/07/2026. Please call my office." dateStart: "22/07/2026" dateEnd: "30/07/2026" immediate: summary: Enable immediately value: number: "+61480013822" content: "Hi, I'm currently unavailable. Please call my office." responses: '200': description: Auto Responder enabled successfully. content: application/json: example: success: true message: Auto Responder enabled data: number: "+61480013822" enabled: true activeNow: true content: "Hi, I'm away from 22/07/2026 to 30/07/2026. Please call my office." dateStart: "22/07/2026" dateEnd: "30/07/2026" dateStartIso: "2026-07-22" dateEndIso: "2026-07-30" originalKvSaved: true routingState: auto_responder lastError: null createdAt: "2026-07-27T23:54:11.422Z" updatedAt: "2026-07-27T23:54:12.694Z" enabledAt: "2026-07-27T23:54:12.694Z" disabledAt: null '400': description: Invalid number, missing content, or invalid date. '401': description: Unauthorized. Missing or invalid Bearer token. '404': description: Number or configuration not found. '409': description: Existing webhook routing could not be saved safely. '500': description: Internal Server Error. '502': description: Cloudflare routing update failed. /api/v2/auto-responder/disable: post: summary: Disable SMS Auto Responder description: | Turn off the Auto Responder and restore your normal webhook. Use the same Bearer token you already use for `/api/v2/sms/send`. You can also disable it by sending this SMS from your number to the same number: ```text Disable: Auto Responder ``` tags: - Messaging security: - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: Your assigned SMS number. example: "+61480013822" required: - number example: number: "+61480013822" responses: '200': description: Auto Responder disabled successfully. content: application/json: example: success: true message: Auto Responder disabled and original KV routing restored data: number: "+61480013822" enabled: false activeNow: false content: "Hi, I'm away from 22/07/2026 to 30/07/2026. Please call my office." dateStart: "22/07/2026" dateEnd: "30/07/2026" dateStartIso: "2026-07-22" dateEndIso: "2026-07-30" originalKvSaved: true routingState: original lastError: null createdAt: "2026-07-27T23:54:11.422Z" updatedAt: "2026-07-28T00:18:31.142Z" enabledAt: "2026-07-27T23:54:12.694Z" disabledAt: "2026-07-28T00:18:31.142Z" '400': description: Invalid or missing phone number. '401': description: Unauthorized. Missing or invalid Bearer token. '404': description: No Auto Responder configuration exists for this number. '409': description: The original webhook could not be restored safely. '500': description: Internal Server Error. '502': description: Cloudflare routing update failed. /api/v2/auto-responder/status: get: summary: Check SMS Auto Responder status description: > Check whether the Auto Responder is on, what message it will send, the active dates, and the webhook currently being used. tags: - Messaging security: - BearerAuth: [] parameters: - in: query name: number required: true schema: type: string example: "+61480013822" description: > Your assigned SMS number. When typing the URL manually, use `%2B` instead of `+`. responses: '200': description: Auto Responder status returned successfully. content: application/json: example: success: true data: number: "+61480013822" enabled: false activeNow: false content: "Hi, I'm away from 22/07/2026 to 30/07/2026. Please call my office." dateStart: "22/07/2026" dateEnd: "30/07/2026" dateStartIso: "2026-07-22" dateEndIso: "2026-07-30" originalKvSaved: true routingState: original lastError: null createdAt: "2026-07-27T23:54:11.422Z" updatedAt: "2026-07-28T00:18:31.142Z" enabledAt: "2026-07-27T23:54:12.694Z" disabledAt: "2026-07-28T00:18:31.142Z" webhook: "https://customer.example.com/sms/webhook" '400': description: Invalid or missing phone number. '401': description: Unauthorized. Missing or invalid Bearer token. '404': description: No Auto Responder configuration exists for this number. '500': description: Internal Server Error. /api/v2/sms/receive: get: summary: Receive SMS description: > System edge endpoint used to register replies from your end-users. Receives incoming message parameter payloads and maps them securely to your corresponding custom URL application callback hooks. tags: - Webhooks parameters: - in: query name: to required: true schema: type: string description: Inbound number receiving the text. - in: query name: from required: true schema: type: string description: The customer's origin mobile tracking handle. - in: query name: id required: false schema: type: string description: System tracking transaction value. - in: query name: content required: false schema: type: string description: Text payload message context sent by customer. - in: query name: coding required: false schema: type: string description: Structural bit layout parameters (0 maps to standard GSM-7). responses: '200': description: Event message translated and pushed to remote webhook successfully. '400': description: Missing core metadata parameters. '404': description: Missing associated application callback endpoint target configurations. '500': description: Outbound callback target failed to return a valid success code. /api/v2/sms/{id}: get: summary: Query specific message properties description: > Pulls comprehensive carrier status flags, metadata details, system segment counts, and active verification tracking statuses mapping to a precise message transaction ID. tags: - Messaging security: - BearerAuth: [] parameters: - in: path name: id required: true schema: type: string description: Message tracking database locator handle. responses: '200': description: Log record metadata properties retrieved successfully. content: application/json: schema: type: object properties: to_addr: type: string from_addr: type: string unicode: type: boolean created_at: type: string format: date-time status: type: string status_at: type: string format: date-time segment_count: type: integer '401': description: Unauthorized credential token pairing. '502': description: Downstream upstream carrier integration update loop failure. '500': description: Internal database query error. /api/v2/sms/info/{number}: get: summary: Retrieve message log history lists description: > Fetches an audit index listing containing historical tracking reference numbers and localized Australian timestamp vectors executed against your designated outbound source. tags: - Storage & Compliance security: - BearerAuth: [] parameters: - in: path name: number required: true schema: type: string description: Target sender phone source number query profile. responses: '200': description: History indexing records compiled and outputted in descending format. content: application/json: schema: type: array items: type: object properties: messageid: type: string date: type: string example: "29/06/2026" time: type: string example: "10:48 am (AEST)" '401': description: Profile access authorization credential check mismatch. '500': description: Data fetch task processing exception.