Realtime messages
A Realtime Message is one message in a channel's ordered history, kept for the channel's `history_retention`.
A Realtime Message is one message in a channel's ordered history, kept for the channel's history_retention. Chat history is durable; edit and unsend are reserved for a later phase.
Service Sylphx Events · Resource type events.sylphx.com/RealtimeMessage · Name pattern orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}/realtime_messages/{realtime_message} · Shape record
Fields
| Field | Type | What it is |
|---|---|---|
name | string | …/realtime_channels/{realtime_channel}/realtime_messages/{realtime_message}. |
uid | string | rtm_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
cursor | string | The message's place in the channel; send it back as after_cursor (or Last-Event-ID) to resume after it. Output only. |
sequence | int64 | The position in the channel, from 1, gap-free. Output only. |
message_type | string | The message name (chat.message, presence.enter, …). Required. |
data | value | The payload. |
client_id | string | The publisher's client id, when it named one. |
publish_time | timestamp | When the channel appended it. Output only. |
content | ChatMessageContent | Structured Chat content, from the same stored event as data. Output only. |
sender | ChatSender | Verified sender metadata; callers cannot set the official badge on a message. Output only. |
reactions | ChatReaction[] | Member reactions, from the same conversation authority. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets one retained message of a channel. |
GET | list | Lists a channel's retained messages, oldest first. |
POST | react | Adds or removes a member reaction on a visible Chat message. |
get
Gets one retained message of a channel.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message · scope events:read · effect read · Request, response and examples
list
Lists a channel's retained messages, oldest first.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages · scope events:read · effect read · paginated · Request, response and examples
react
Adds or removes a member reaction on a visible Chat message.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message:react · scope events:write · effect write · Request, response and examples