Get User Presence

Returns the online status of the specified user.

Get presence information about a particular user.

GETyourpodURL.symphony.com/pod/v3/user/{uid}/presence

Path parameters

uid*integer (int64)

User ID as a decimal integer

Query parameters

Header parameters

Response

200400401403404500

OK

Body

application/json

category*string

Presence status. Possible values are:

• UNDEFINED
• AVAILABLE
• BUSY
• DO_NOT_DISTURB
• ON_THE_PHONE
• BE_RIGHT_BACK
• IN_A_MEETING
• AWAY
• OUT_OF_OFFICE
• OFF_WORK
• OFFLINE

userIdinteger (int64)

The ID of the user to whom the presence state relates.

timestampinteger (int64)

The time, in milliseconds since Jan 1 1970, when the presence state was set.

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v3/user/{uid}/presence', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "category": "AWAY",
  "userId": 14568529068038,
  "timestamp": 1533928483800
}

The timestamp in the response is in UTC format and contains the time when the presence was set using Set Presence. For users who are offline, the timestamp contains the current time when the Get User Presence endpoint was invoked.

To get the presence of external users, you must first register interest about their presence.

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

The available online status values (presence categories) for users are listed on the Get Presence page.

Query Presence of External Users

To query the presence of external users, you must first perform an additional step:

1. Call the Register Interest in External User Presence endpoint to register interest in those users.

2. Call this endpoint to query the presence of each user.

To query the presence of internal users, you do not need to register interest and can call this endpoint directly.