Get a message by ID

GET

messages

{messageId}

Get a message by ID

curl --request GET \
  --url https://api.relayapp.im/v1/messages/{messageId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_from_me": true,
  "delivery_status": "sent",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_system_message": true,
  "from": "<string>",
  "from_handle": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "handle": "<string>",
    "joined_at": "2023-11-07T05:31:56Z",
    "kind": "user",
    "display_name": "<string>",
    "image_url": "<string>",
    "image_color": "<string>",
    "about": "<string>",
    "verified": true,
    "is_contact": true,
    "status": "active",
    "left_at": "2023-11-07T05:31:56Z",
    "is_me": true
  },
  "parts": [
    {
      "type": "text",
      "value": "<string>",
      "reactions": [
        {
          "is_me": true,
          "handle": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "handle": "<string>",
            "joined_at": "2023-11-07T05:31:56Z",
            "kind": "user",
            "display_name": "<string>",
            "image_url": "<string>",
            "image_color": "<string>",
            "about": "<string>",
            "verified": true,
            "is_contact": true,
            "status": "active",
            "left_at": "2023-11-07T05:31:56Z",
            "is_me": true
          },
          "type": "love",
          "custom_emoji": "<string>"
        }
      ],
      "mentions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "handle": "<string>",
          "is_me": true,
          "range": [
            1
          ]
        }
      ],
      "mention": "<string>",
      "mention_range": "<array>"
    }
  ],
  "reply_to": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "part_index": 1
  },
  "thread": {
    "originator_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originator_part_index": 1
  },
  "sent_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "read_at": "2023-11-07T05:31:56Z",
  "edited_at": "2023-11-07T05:31:56Z",
  "unsent_at": "2023-11-07T05:31:56Z",
  "silent": true,
  "deliveries": [
    {
      "contact": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "handle": "<string>",
        "joined_at": "2023-11-07T05:31:56Z",
        "kind": "user",
        "display_name": "<string>",
        "image_url": "<string>",
        "image_color": "<string>",
        "about": "<string>",
        "verified": true,
        "is_contact": true,
        "status": "active",
        "left_at": "2023-11-07T05:31:56Z",
        "is_me": true
      },
      "delivered_at": "2023-11-07T05:31:56Z",
      "read_at": "2023-11-07T05:31:56Z"
    }
  ],
  "system_event": {
    "type": "chat_created",
    "actor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handle": "<string>",
      "kind": "user"
    },
    "subject": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handle": "<string>",
      "kind": "user"
    },
    "value": "<string>",
    "icon_attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_card": {
      "first_name": "<string>",
      "last_name": "<string>",
      "image_url": "<string>",
      "image_color": "<string>",
      "is_active": true,
      "handle": "<string>",
      "kind": "user"
    }
  }
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Path Parameters

messageId

string<uuid>

required

Unique identifier of the message to retrieve

Response

Message found and returned successfully

string<uuid>

required

Unique identifier for the message

chat_id

string<uuid>

required

ID of the chat this message belongs to

is_from_me

boolean

required

Whether this message was sent by the authenticated user

delivery_status

enum<string>

required

Current receipt state. Sent is a client-only handoff state. Delivered means Relay accepted and stored the Message. Read means every recipient explicitly marked the Chat Read.

Available options:

sent,

delivered,

read

created_at

string<date-time>

required

When the message was created

updated_at

string<date-time>

required

When the message was last updated

is_system_message

boolean

required

Whether this timeline item is a visible Chat event.

from

string | null

Sender Relay Handle.

from_handle

object | null

The sender of this message as a full handle object

Show child attributes

parts

object[] | null

Message parts in order (text, media, and link)

A text message part

Option 1
Option 2
Option 3
Option 4

Show child attributes

reply_to

object | null

Indicates this message is a threaded reply to another message

Show child attributes

thread

object | null

The thread this Message belongs to, or null when it is not a reply.

Show child attributes

sent_at

string<date-time> | null

When the message was sent

delivered_at

string<date-time> | null

When Relay accepted and stored the Message. For a committed Message, this is the same instant as created_at.

read_at

string<date-time> | null

When the message was read

edited_at

string<date-time> | null

When the message was last edited, or null if it was never edited.

unsent_at

string<date-time> | null

When the sender unsent the message, or null. An unsent Message keeps its place in the transcript and carries no parts.

silent

boolean

Whether the sender sent this Message silently, so the recipient's device showed no banner and played no sound.

deliveries

object[]

Per-recipient Delivered and Read truth for direct and group Chats. Relay derives this because it controls every recipient endpoint.

Show child attributes

system_event

object | null

Show child attributes

Get a message by ID

curl --request GET \
  --url https://api.relayapp.im/v1/messages/{messageId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_from_me": true,
  "delivery_status": "sent",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_system_message": true,
  "from": "<string>",
  "from_handle": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "handle": "<string>",
    "joined_at": "2023-11-07T05:31:56Z",
    "kind": "user",
    "display_name": "<string>",
    "image_url": "<string>",
    "image_color": "<string>",
    "about": "<string>",
    "verified": true,
    "is_contact": true,
    "status": "active",
    "left_at": "2023-11-07T05:31:56Z",
    "is_me": true
  },
  "parts": [
    {
      "type": "text",
      "value": "<string>",
      "reactions": [
        {
          "is_me": true,
          "handle": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "handle": "<string>",
            "joined_at": "2023-11-07T05:31:56Z",
            "kind": "user",
            "display_name": "<string>",
            "image_url": "<string>",
            "image_color": "<string>",
            "about": "<string>",
            "verified": true,
            "is_contact": true,
            "status": "active",
            "left_at": "2023-11-07T05:31:56Z",
            "is_me": true
          },
          "type": "love",
          "custom_emoji": "<string>"
        }
      ],
      "mentions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "handle": "<string>",
          "is_me": true,
          "range": [
            1
          ]
        }
      ],
      "mention": "<string>",
      "mention_range": "<array>"
    }
  ],
  "reply_to": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "part_index": 1
  },
  "thread": {
    "originator_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originator_part_index": 1
  },
  "sent_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "read_at": "2023-11-07T05:31:56Z",
  "edited_at": "2023-11-07T05:31:56Z",
  "unsent_at": "2023-11-07T05:31:56Z",
  "silent": true,
  "deliveries": [
    {
      "contact": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "handle": "<string>",
        "joined_at": "2023-11-07T05:31:56Z",
        "kind": "user",
        "display_name": "<string>",
        "image_url": "<string>",
        "image_color": "<string>",
        "about": "<string>",
        "verified": true,
        "is_contact": true,
        "status": "active",
        "left_at": "2023-11-07T05:31:56Z",
        "is_me": true
      },
      "delivered_at": "2023-11-07T05:31:56Z",
      "read_at": "2023-11-07T05:31:56Z"
    }
  ],
  "system_event": {
    "type": "chat_created",
    "actor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handle": "<string>",
      "kind": "user"
    },
    "subject": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handle": "<string>",
      "kind": "user"
    },
    "value": "<string>",
    "icon_attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_card": {
      "first_name": "<string>",
      "last_name": "<string>",
      "image_url": "<string>",
      "image_color": "<string>",
      "is_active": true,
      "handle": "<string>",
      "kind": "user"
    }
  }
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

Overview

Chats

Messages

Attachments

Contacts

Webhooks

WebSocket

Agents

Get a message by ID

Authorizations

Path Parameters

Response