Skip to main content
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

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

​
Headers

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

​
Example

​
Response

Returns a single message object with the current delivery status.
​
string
Unique message ID assigned by RelayOS.
​
string
Current delivery status. See the lifecycle note below for the complete set of values and transitions.
​
string
Recipient phone number in E.164 format.
​
string
Name of the template used for this message.
​
string
ISO 8601 timestamp of when RelayOS accepted the message into the queue.

​
Status lifecycle

A message moves through the following states after you send it:
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.