Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifacts API
- Assets API
- Auth configs API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
React a realtime message
Adds or removes a member reaction on a visible Chat message.
Adds or removes a member reaction on a visible Chat message.
- Path
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— a successful call changes state. - Collection realtime_messages
#Request
| Field | Type | What it is |
|---|---|---|
name | string | Existing message resource name. Required. |
client_id | string | Authenticated reacting member. |
emoji | string | Emoji, at most 32 UTF-8 bytes. |
remove | bool | Remove instead of add. |
#Response
| 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. |
#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. |
#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. |
#Errors
PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message:react" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'