On this page
List realtime messages
Lists a channel's retained messages, oldest first.
Lists a channel's retained messages, oldest first.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages - Scope
events:read - Effect
read— nothing is written. - Collection realtime_messages
- Query
page_size,page_token,filter,client_id,after_cursor,before_cursor - Pagination the answer carries
realtime_messagesand, when there is more,next_page_token
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The realtime channel. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | Empty, or sequence > N to start after message N (resume). |
client_id | string | Chat viewer; required on Chat channels. The trusted tenant backend binds identity. |
after_cursor | string | Exclusive cursor, for forward recovery. Cannot combine with before_cursor or filter. |
before_cursor | string | Exclusive cursor, for backwards history, newest first. Cannot combine with after_cursor or filter. |
Response
| Field | Type | What it is |
|---|---|---|
realtime_messages | RealtimeMessage[] | The page, oldest first. |
next_page_token | string | The token of the next page; empty on the last page. |
RealtimeMessage
| 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. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
ChatMessageContent
| Field | Type | What it is |
|---|---|---|
text | string | UTF-8 text, at most 4000 characters. |
image | ChatImage | An image with a prior moderation approval. |
location | ChatLocation | One explicit static location pin. |
poll | ChatPoll | A member poll. |
room_invite | string | Existing Realtime room resource name for a Join Game card. |
reply_to_cursor | string | Optional cursor of the quoted message in this channel. |
mentioned_client_ids | string[] | Member ids mentioned by this message. |
sticker | ChatSticker | A paid catalog asset; the server verifies entitlement and stamps its bytes. |
ChatSender
| Field | Type | What it is |
|---|---|---|
client_id | string | The authenticated user's stable platform identity as bound by its backend. |
display_name | string | Display name, from the sender's profile. |
official | bool | Verified official status, assigned through a trusted backend operation. |
cosmetics | ChatCosmetics | Persisted trusted appearance when this message was accepted. Output only. |
ChatReaction
| Field | Type | What it is |
|---|---|---|
emoji | string | Reaction emoji. |
count | int32 | Number of members with this reaction. |
client_ids | string[] | Stable reacting member identities. |
ChatImage
| Field | Type | What it is |
|---|---|---|
content_uri | string | Existing storage or Artifacts URI; no image bytes are carried here. Required. |
sha256 | string | Lowercase SHA-256, 64 hexadecimal characters. Required. |
ChatLocation
| Field | Type | What it is |
|---|---|---|
latitude | double | Degrees north, inclusive -90 to 90. |
longitude | double | Degrees east, inclusive -180 to 180. |
label | string | Optional venue label; never continuous or background location. |
ChatPoll
| Field | Type | What it is |
|---|---|---|
question | string | Question shown to members. |
options | string[] | Two to ten distinct choices. |
ChatSticker
| Field | Type | What it is |
|---|---|---|
pack_id | string | Catalog pack identifier; the complete Money feature key is at most 64 bytes. Required. |
sticker_id | string | Identifier inside the pack. Required. |
content_uri | string | Optional on send; if supplied must match the catalog. Output is authoritative. |
sha256 | string | Optional on send; exact lowercase SHA-256 from the catalog. |
mime_type | string | Optional on send; exact catalog image MIME type. |
ChatCosmetics
| Field | Type | What it is |
|---|---|---|
avatar_frame_id | string | Owned avatar-frame identifier, assigned by the trusted backend. |
name_color_id | string | Owned name-color identifier, assigned by the trusted backend. |
title_badge_id | string | Owned title-badge identifier, assigned by the trusted backend. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages" \
-H "Authorization: Bearer $SYLPHX_API_KEY"