Create account
Documentation menu

API reference / current route handlers

Small enough to verify.

Base URL: https://aussiesms.net. The stable public contract uses the route handlers below, not a fictional `/v1` API.

Authentication

Supply either Authorization: Bearer YOUR_API_KEY or X-API-Key: YOUR_API_KEY. Missing, inactive, or invalid keys return HTTP 401.

POST/api/gateway/send

Queue one SMS. A direct message body needs to (or the legacy alias phone) and message.

JSON|Direct message body
{
  "to": "+61400000000",
  "message": "Your booking is confirmed."
}

A stored account template may be referenced with templateIdand optional string variables. Template management itself is a dashboard workflow, not a separately documented stable public API.

JSON|Stored template body
{
  "to": "+61400000000",
  "templateId": "00000000-0000-0000-0000-000000000000",
  "variables": {
    "name": "Taylor"
  }
}
200Accepted into the queue; one credit charged.
400Missing phone or message input.
401Missing or invalid API key.
402Insufficient prepaid credits.
404Requested account template not found.
429Current rate check rejected the request.
500Queue or server failure.

GET/api/gateway/send?id=MESSAGE_ID

Return status timestamps and an error field for a message owned by the authenticated API-key user. The endpoint returns 404 for missing or non-owned rows and does not expose cross-account message details.

Webhook boundary

Webhook configuration exists in the authenticated application, but no external webhook event schema is promoted as a stable public contract in this release candidate. Do not build against undocumented payloads.