---
title: "GET /messages"
method: GET
path: "/messages"
tags: ["messages"]
---

# GET /messages

`GET /messages`

## Request

- Base URL: `https://api.sms.optus.com.au/rest/sms/v2`
- URL: `https://api.sms.optus.com.au/rest/sms/v2/messages`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/optus/apis/sms-gateway-rest-apiv2/docs/messages/get.ts> (a function with typed inputs; its response is checked against the schema)

Get message details for an existing message

## Query parameters

- `id` string, required: A string with UUID format.

## Response `200`

Get Message response structure.

- MessageDetails: Message details structure.
  - `id` string, uuid
  - `source` string, none: The source for the message
  - `destination` string, none: The destination for the message
  - `direction` 'MO' | 'MT'
  - `reference` string, none
  - `content` string, none
  - `status` 'accepted' | 'queued' | 'submitted' | 'sent' | 'received' | 'blocked' | 'deficient' | 'frozen' | 'rejected' | 'failed' | 'dead' | 'expired'

## Other responses

- `default`: API Error Response

---

[API](https://skmtc.dev/optus/apis/sms-gateway-rest-apiv2.md) - [All operations](https://skmtc.dev/optus/apis/sms-gateway-rest-apiv2/llms.txt) - [OpenAPI document](https://skmtc.dev/optus/apis/sms-gateway-rest-apiv2/revisions/70d00901e359?raw)
