Skip to content

Realtime

realtime_presence_enter

Enter presence on a realtime channel; upserts the caller (or member_id) into the roster

Tool

realtime_presence_enter

Enter presence on a realtime channel; upserts the caller (or member_id) into the roster

Enter presence on a realtime channel; upserts the caller (or member_id) into the roster

Behavior

HTTP
POST /realtime/presence/enter

Arguments

NameTypeRequiredDescription
infostringArbitrary JSON metadata for the member (<=10KB serialized)
channelstringChannel name, "namespace:rest"
member_idstringAct for a synthetic member id instead of the caller identity (backend integrations)
ttl_secondsintegerPresence entry TTL in seconds (1-3600)

Response

FieldTypeAlwaysDescription
memberobjectThe entered/updated member
channelstringChannel name

Try it

Enter presence on a realtime channel; upserts the caller (or member_id) into the roster.

When to use

Enter presence on a realtime channel; upserts the caller (or member_id) into the roster

Example

Ask your agent something like this:

Enter presence on a realtime channel; upserts the caller (or member_id) into the roster.

The agent will invoke realtime_presence_enter with these arguments:

{
  "channel": "<channel>"
}

Esc

Start typing to search the docs.

navigateselect