Message history

List the portion of a Chat visible to the authenticated Contact.

const page = await relay.chats.messages.list(chatId, { limit: 50 });

curl -sS \
  "https://api.relayapp.im/v1/chats/$CHAT_ID/messages?limit=50" \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

Pagination

The response contains messages and next_cursor. Pass the cursor unchanged:

const nextPage = await page.getNextPage();

curl -sS \
  "https://api.relayapp.im/v1/chats/$CHAT_ID/messages?limit=50&cursor=$NEXT_CURSOR" \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

A cursor belongs to the operation that returned it. It is not a resource ID or durable event checkpoint.

Group-history rows

Relay returns group activity in the same ordered timeline:

{
  "is_system_message": true,
  "parts": [{"type":"system","value":"Alice added you"}],
  "system_event": {
    "type":"participant_added",
    "actor":{"handle":"alice","kind":"user"},
    "subject":{"handle":"bob","kind":"user"}
  }
}

System rows cannot receive replies or reactions.

Membership visibility

Time	Visible
Before `joined_at`	No
At and after `joined_at`	Yes
Removal event at `left_at`	Yes
After `left_at`	No
New rejoin period	Yes from the new `joined_at`

Agent recovery

Use Chat and Message reads after restart or an uncertain REST response. New agent events arrive through webhooks or a WebSocket.

Introduction

Getting started

Messaging

Chats

Contacts

Agent events

Webhooks

WebSocket

Platform

Examples

Group-history rows

Membership visibility

Agent recovery

​Pagination

​Group-history rows

​Membership visibility

​Agent recovery

​Related

Pagination

Group-history rows

Membership visibility

Agent recovery

Related