Message Status

Look up delivery status for one or more messages by message ID or mobile number.

The Message Status endpoint returns delivery status for messages you’ve sent, looked up either by messageId or by mobileNumber with a date range.

Endpoint

POST https://api.onexaura.com/status

Headers

apikey · string · required

API key issued by OneXtel, used for authentication.

Choosing a lookup

You must supply either messageId or mobileNumber — never both.

Lookup by	Date range
messageId	Optional
mobileNumber	Required — from and to must both be supplied

Passing messageId and mobileNumber in the same request returns an error. Supplying neither does too — one of the two is always required.

Request body

The request body is a JSON object.

channel · string · required

Channel to query — whatsapp, rcs, or sms.

Verified against the live API (Aug 2026): when looking up by messageId, the channel value is not validated — whatsapp, wa, sms, an arbitrary string, and omitting the field entirely all return the same record. A message ID is already unique, so the channel adds nothing. It is still worth sending the correct value: it is likely to matter for mobileNumber lookups, where the same number can appear on more than one channel.

taId · integer

Tenant administrator ID. Scopes the query to a tenant.

tucId · integer

TUC ID. Scopes the query to a specific account under the tenant.

Verified: taId and tucId are optional. Requests omitting both return the same result, because the API key already identifies the account. They appear in requests from tenant-level callers, where they scope the lookup to one account under the tenant.

messageId · array

Array of message IDs to look up. Required unless mobileNumber is supplied, and mutually exclusive with it.

mobileNumber · array

Array of recipient mobile numbers, with country code. Required unless messageId is supplied, and mutually exclusive with it.

from · string

Start of date range, formatted YYYY-MM-DD HH:mm:ss — for example "2025-12-17 00:00:00". Mandatory when querying by mobileNumber.

to · string

End of date range, formatted YYYY-MM-DD HH:mm:ss — for example "2025-12-17 23:59:59". Mandatory when querying by mobileNumber.

pageNo · integer · default: "0"

Page number for paginated results.

limit · integer · default: "10"

Number of records to return per page.

Example request

cURL

curl --request POST \
  --url https://api.onexaura.com/status \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "taId": 10,
  "tucId": 2002,
  "channel": "whatsapp",
  "messageId": [
    "3I7dnaYRaiTVj8f5EgxsoiJrT5R"
  ],
  "pageNo": 0,
  "limit": 100
}'

Response

{
  "data": [
    {
      "uuid": "3I7dnaYRaiTVj8f5EgxsoiJrT5R",
      "mobileNumber": "919999999999",
      "status": "DELIVERED",
      "failedErrorCode": "000",
      "failedErrorMessage": "Delivered",
      "onexReceivedTs": 1786517520081,
      "credit": 1,
      "buttonClick": 0,
      "urlClick": 0,
      "customParam1": "",
      "customParam2": "",
      "customParam3": "",
      "customParam4": "",
      "customParam5": ""
    }
  ],
  "pagination": {
    "totalRecords": 1
  }
}

data · array

One object per matching message.

pagination.totalRecords · integer

Total number of records matching the query, across all pages.

Record fields

uuid · string

Unique message identifier — the same value returned when the message was sent.

mobileNumber · string

Recipient number.

status · string

Current delivery state.

failedErrorCode · string

Outcome code. 000 is delivered; anything else is a failure reason — see SMS error codes.

failedErrorMessage · string

Human-readable description of failedErrorCode.

onexReceivedTs · integer

Timestamp in epoch milliseconds at which the platform received the status.

credit · integer

Credits consumed by the message.

buttonClick · integer

Whether a button in the message was clicked.

urlClick · integer

Whether a tracked URL in the message was clicked.

customParam1 · string

Custom reference set on the original send, echoed back. customParam1 through customParam5.

failedErrorCode here is the same code set as the SMS error codes table, despite the field name — it carries 000 on success too, not only on failure.

Errors

An invalid or missing API key returns HTTP 400 with the body:

"NO VALID AUTH_KEY FOUND!"

Related

• RCS delivery notification — push delivery status instead of polling for it
• WhatsApp callback events
• Message history