Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.relayos.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to fetch the latest status and metadata for a single message. This is useful for polling delivery progress after calling POST /v1/messages, or for auditing a specific message by its ID.

​
Request

GET https://api.relayos.com.br/v1/messages/{id}

​
Path parameters

​
id
string
required
The unique message ID returned by POST /v1/messages. Example: msg_01hwz3k9fxe5vr2t8qn6yc4bmd.

​
Headers

​
Authorization
string
required
Bearer token for your RelayOS API key. Format: Bearer YOUR_API_KEY.

​
Example

curl https://api.relayos.com.br/v1/messages/msg_01hwz3k9fxe5vr2t8qn6yc4bmd \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

Returns a single message object with the current delivery status.
​
id
string
Unique message ID assigned by RelayOS.
​
status
string
Current delivery status. See the lifecycle note below for the complete set of values and transitions.
​
to
string
Recipient phone number in E.164 format.
​
template
string
Name of the template used for this message.
​
queuedAt
string
ISO 8601 timestamp of when RelayOS accepted the message into the queue.
{
  "id": "msg_01hwz3k9fxe5vr2t8qn6yc4bmd",
  "status": "DELIVERED",
  "to": "+5511999998888",
  "template": "lembrete_consulta",
  "queuedAt": "2026-05-14T10:30:00Z"
}

​
Status lifecycle

A message moves through the following states after you send it: 
QUEUED → SENT → DELIVERED → READ
                     ↓
                   FAILED
StatusDescription
QUEUEDRelayOS accepted the message; not yet submitted to Meta
SENTSubmitted to the WhatsApp Cloud API successfully
DELIVEREDConfirmed delivered to the recipient’s device
READRecipient opened the message
FAILEDDelivery failed after all automatic retry attempts
For real-time status updates, configure a callbackUrl on your project. RelayOS will POST a webhook event to that URL each time a message changes state, so you don’t need to poll this endpoint.