> ## Documentation Index
> Fetch the complete documentation index at: https://omni.fireflo.au/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/messages/{message_id}

> One message sent through the API, with every attempt on every channel.

One message, with the route it follows and every attempt made on every channel so far.

<Note>Needs the `messages:read` scope.</Note>

## Path parameters

| Field | Type | Required | Notes |
| :- | :- | :- | :- |
| `message_id` | string | Yes | The message's id, `msg_…`. |

## Request

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.fireflo.au/v1/messages/msg_8f14e45fceea167a5a36dedd4bea2543 \
    -H "Authorization: Bearer $OMNI_API_KEY"
  ```

  ```python Python theme={null}
  import os

  import requests

  response = requests.get(
      "https://api.fireflo.au/v1/messages/msg_8f14e45fceea167a5a36dedd4bea2543",
      headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
  )
  print(response.status_code, response.json())
  ```

  ```javascript Node theme={null}
  const response = await fetch("https://api.fireflo.au/v1/messages/msg_8f14e45fceea167a5a36dedd4bea2543", {
    headers: {
      Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
    },
  });
  console.log(response.status, await response.json());
  ```
</CodeGroup>

## Response

`200 OK`

```json theme={null}
{
  "id": "msg_8f14e45fceea167a5a36dedd4bea2543",
  "status": "succeeded",
  "to": "+919876543210",
  "reference": "order-A-1042",
  "purpose": "transactional",
  "test": false,
  "outcome": {
    "channel": "sms",
    "status": "delivered"
  },
  "error": null,
  "steps": [
    {
      "channel": "whatsapp",
      "succeed_on": "read",
      "within": 600
    },
    {
      "channel": "sms",
      "succeed_on": "delivered",
      "within": 900
    }
  ],
  "attempts": [
    {
      "step": 0,
      "channel": "whatsapp",
      "status": "timed_out",
      "code": null,
      "reason": null,
      "channel_message": "cm_918273",
      "at": "2026-10-05T09:14:22.518204+00:00",
      "updated": "2026-10-05T09:24:30.004117+00:00"
    },
    {
      "step": 1,
      "channel": "sms",
      "status": "delivered",
      "code": null,
      "reason": null,
      "channel_message": "cm_918411",
      "at": "2026-10-05T09:24:30.091562+00:00",
      "updated": "2026-10-05T09:24:36.710348+00:00"
    }
  ],
  "created": "2026-10-05T09:14:22.413512+00:00",
  "finished_at": "2026-10-05T09:24:36.710348+00:00"
}
```

### The message

| Field | Notes |
| :- | :- |
| `id` | `msg_` and 32 hex characters. |
| `status` | `delivering` (trying a channel or waiting for its report), `postponed` (held until the person's quiet hours end), then one of `succeeded`, `failed`, `expired` or `canceled`. |
| `to` | The number, in international format. |
| `reference`, `purpose` | As sent. |
| `test` | True when sent with a test key: no channel is reached, and the first step succeeds at once. |
| `outcome` | Once it succeeded: `{"channel", "status"}` — the channel that got there and how far (`sent`, `delivered`, `read` or `answered`). Otherwise null. |
| `error` | Once it failed, expired or was canceled: `{"code", "message"}`, with code `not_permitted` (the person may not be contacted), `no_channel_left`, `expired` or `canceled`. Otherwise null. |
| `steps` | The route it follows: each `{"channel", "succeed_on", "within"}`. |
| `attempts` | One per channel tried: `step` (from 0), `channel`, `status` (`refused`, `sent`, `delivered`, `read`, `answered`, `failed` or `timed_out`), `code` and `reason` when refused, `channel_message` (the `cm_` id of the message it sent, or null), `call` (the id of the call a Voice step placed, or null), `at`, `updated`. |
| `created`, `finished_at` | When it was asked for, and when it settled (null until then). |

An attempt is `refused` when its channel can't take the message now and the next step runs at once. Its `code` says why: `channel_off`, `no_content`, `window_closed` (WhatsApp's 24-hour window is closed and no approved template was given), `no_dlt_match` (the SMS text fills in none of your registered DLT templates), `not_permitted` or `provider_refused`.

## Errors

Every refusal is `{"error": {"code", "message", "field"}}`; `field` is there when one input is at fault.

| Status | Error code | When |
| :- | :- | :- |
| 404 | `not_found` | No message has that id on this account. |
| 403 | `scope_missing` | The key doesn't have the `messages:read` scope. |

Any request can also be refused for its key, its account or its rate (`key_required`, `invalid_key`, `account_suspended`, `plan_excludes_api`, `address_not_allowed`, `rate_limited`); see [the overview](/api-reference/overview).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.