Skip to content
Console
On this page

Get a realtime message

Gets one retained message of a channel.

Gets one retained message of a channel.

  • Path 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 — nothing is written.
  • Collection realtime_messages
  • Query client_id

Request

FieldTypeWhat it is
namestringThe name of the message. Required.
client_idstringChat viewer; required on Chat channels.

Response

FieldTypeWhat it is
namestring…/realtime_channels/{realtime_channel}/realtime_messages/{realtime_message}.
uidstringrtm_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
cursorstringThe message's place in the channel; send it back as after_cursor (or Last-Event-ID) to resume after it. Output only.
sequenceint64The position in the channel, from 1, gap-free. Output only.
message_typestringThe message name (chat.message, presence.enter, …). Required.
datavalueThe payload.
client_idstringThe publisher's client id, when it named one.
publish_timetimestampWhen the channel appended it. Output only.
contentChatMessageContentStructured Chat content, from the same stored event as data. Output only.
senderChatSenderVerified sender metadata; callers cannot set the official badge on a message. Output only.
reactionsChatReaction[]Member reactions, from the same conversation authority. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

ChatMessageContent

FieldTypeWhat it is
textstringUTF-8 text, at most 4000 characters.
imageChatImageAn image with a prior moderation approval.
locationChatLocationOne explicit static location pin.
pollChatPollA member poll.
room_invitestringExisting Realtime room resource name for a Join Game card.
reply_to_cursorstringOptional cursor of the quoted message in this channel.
mentioned_client_idsstring[]Member ids mentioned by this message.
stickerChatStickerA paid catalog asset; the server verifies entitlement and stamps its bytes.

ChatSender

FieldTypeWhat it is
client_idstringThe authenticated user's stable platform identity as bound by its backend.
display_namestringDisplay name, from the sender's profile.
officialboolVerified official status, assigned through a trusted backend operation.
cosmeticsChatCosmeticsPersisted trusted appearance when this message was accepted. Output only.

ChatReaction

FieldTypeWhat it is
emojistringReaction emoji.
countint32Number of members with this reaction.
client_idsstring[]Stable reacting member identities.

ChatImage

FieldTypeWhat it is
content_uristringExisting storage or Artifacts URI; no image bytes are carried here. Required.
sha256stringLowercase SHA-256, 64 hexadecimal characters. Required.

ChatLocation

FieldTypeWhat it is
latitudedoubleDegrees north, inclusive -90 to 90.
longitudedoubleDegrees east, inclusive -180 to 180.
labelstringOptional venue label; never continuous or background location.

ChatPoll

FieldTypeWhat it is
questionstringQuestion shown to members.
optionsstring[]Two to ten distinct choices.

ChatSticker

FieldTypeWhat it is
pack_idstringCatalog pack identifier; the complete Money feature key is at most 64 bytes. Required.
sticker_idstringIdentifier inside the pack. Required.
content_uristringOptional on send; if supplied must match the catalog. Output is authoritative.
sha256stringOptional on send; exact lowercase SHA-256 from the catalog.
mime_typestringOptional on send; exact catalog image MIME type.

ChatCosmetics

FieldTypeWhat it is
avatar_frame_idstringOwned avatar-frame identifier, assigned by the trusted backend.
name_color_idstringOwned name-color identifier, assigned by the trusted backend.
title_badge_idstringOwned title-badge identifier, assigned by the trusted backend.

Errors

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/realtime-message" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"