External Presence Interest

To get the presence state of external users, you must first register interest in those users using this endpoint.

Register interest in a user's presence status

POSTyourpodURL.symphony.com/pod/v1/user/presence/register

Header parameters

Body

application/json

List of (integer) User IDs of users whose presence to query

itemsinteger (int64)

Response

200400401403404500

OK

Body

application/json

formatenum

Example: "TEXT"

TEXTXML

messagestring

Example: "Success"

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/user/presence/register', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      7215545058313,
      7215545078461
    ]),
});
const data = await response.json();

Response

200400401403404500

{
  "format": "TEXT",
  "message": "Success"
}

Request Example

curl -X POST \
  https://acme.symphony.com/pod/v1/user/presence/register \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -d '[7215545078541, 7215545078461]'

When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.

Querying Presence of External Users

📘 External Users Presence Visibility

Any user can see the presence of other users of the same company. For users of a different company, the two users must be connected to see presence.

To query the presence of external users:

1. Call this endpoint to register interest in the desired users.

2. Call the Get User Presence endpoint to query the presence of each user. To keep the registration active, call this endpoint every hour.

To query the presence of internal users, you do not need to register interest.

❗️ Rate Limit

Getting an external user’s presence is limited to one call every 5 minutes.

🚧 Roles and Privileges

Calling this endpoint requires the ADMIN_PRESENCE_UPDATE privilege. See Bot Permissions for a list of roles and associated privileges.