Get user presence

GET https://chat.zmt-datalab.de/api/v1/users/{user_id_or_email}/presence

Get the presence status for a specific user.

This endpoint is most useful for embedding data about a user's presence status in other sites (e.g. an employee directory). Full Zulip clients like mobile/desktop apps will want to use the main presence endpoint, which returns data for all active users in the organization, instead.

See Zulip's developer documentation for details on the data model for presence in Zulip.

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Get presence information for "iago@zulip.com"
result = client.get_user_presence("iago@zulip.com")
print(result)

curl -sSX GET -G https://chat.zmt-datalab.de/api/v1/users/iago@zulip.com/presence \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

Response

Return values

• presence: object

  An object containing the presence details for every client the user has logged into.

  • {client_name} or aggregated: object

    Object containing the details of the user's presence on a particular platform.

    Generally, the keys for these objects are the names of the different clients where this user is logged in, for example website or ZulipDesktop.

    There is also an aggregated key, which matches the contents of the object that has been updated most recently.

    For most applications, you'll just want to look at the aggregated key.

    • timestamp: integer

      When this update was received. If the timestamp is more than a few minutes in the past, the user is offline.

    • status: string

      Whether the user had recently interacted with Zulip at the time of the timestamp.

      Will be either active or idle

Example response(s)

A typical successful JSON response may look like:

{
    "msg": "",
    "presence": {
        "ZulipMobile": {
            "status": "active",
            "timestamp": 1522687421
        },
        "aggregated": {
            "status": "active",
            "timestamp": 1532697622
        },
        "website": {
            "status": "active",
            "timestamp": 1532697622
        }
    },
    "result": "success"
}