Get User Presence

Returns the online status of the specified user.

Get presence information about a particular user.

get

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Query parameters

localbooleanOptional

If true, a local query will be performed and the presence will be set to OFFLINE for users who are not local to the calling user's pod. If false or absent, then the presence of all local users and the presence of all external users to whom the calling user is connected will be queried.

For external users, a "presence interest" should be registered through /v1/user/presence/register before querying for presence.

Default: false

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

OK

application/json

categorystringRequired

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

Example: AWAY

userIdinteger · int64Optional

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

Example: 14568529068038

timestampinteger · int64Optional

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

Example: 1533928483800

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

Not Found: user id cannot be located.

application/json

500

Server error, see response body for further details.

application/json

get/v3/user/{uid}/presence

HTTPcURLJavaScriptPython

GET /pod/v3/user/{uid}/presence HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "category": "AVAILABLE",
  "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.