Documentation Index

Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt

Use this file to discover all available pages before exploring further.

Set User Presence (Realtime)

Prev Next

Set the user presence status. By default, there are four different statuses available in your workspace:

  • online

  • busy

  • away

  • offline

Set default user presence status

Method

Requires Auth

UserPresence:setDefaultStatus

Yes

Payload parameters

Argument

Example

Required

Description

status

online

Required

The user presence status to be set as default.

Example call

{
    "msg": "method",
    "method": "UserPresence:setDefaultStatus",
    "id": "42",
    "params": [ "online" ]
}

Example response

{
    "msg": "result",
    "id": "42",
    "result": true
}

Set temporary user presence status

To set a temporary status, send a request to UserPresence:{status} with empty parameters. It only accepts either of these two status options: away and online. It is particularly useful when the client detects that the user is currently not actively using the application (thus "away") and when the user returns, indicating they are "online" again.

Method

Requires Auth

UserPresence:away

Yes

Example call

{
    "msg": "method",
    "method": "UserPresence:away",
    "id": "47",
    "params":[]
}

Example response

{
    "msg": "result",
    "id": "42",
    "result": true
}