Get Presence

Returns the online status of the calling user.

Get presence information about the requesting user.

get

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

500

Server error, see response body for further details.

application/json

get/v2/user/presence

GET /pod/v2/user/presence HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

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

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:

Presence category	Interface icon	External view	Comment
AVAILABLE	Green check mark	AVAILABLE	Released in 1.46
AWAY	Yellow clock	AWAY	Released in 1.46
OFFLINE	Grey cross	OFFLINE	Introduced in 20.16
BUSY	Red sign	BUSY	Released in 1.46
ON_THE_PHONE	Red phone	ON_THE_PHONE	Released in 1.46
BE_RIGHT_BACK	Yellow clock	AWAY	Released in 1.47
IN_A_MEETING	Red phone	IN_A_MEETING	Released in 1.47
OUT_OF_OFFICE	Purple circle	OUT_OF_OFFICE	Released in 1.47
OFF_WORK	Yellow clock	OFFLINE	Deprecated in 20.16
DO_NOT_DISTURB	Red circle	AWAY	Deprecated in 20.16

See Set Presence for a description of the Presence category and External view values for internal and external users.

Note: It is also possible for Symphony users to have other presence values, which should be handled in your implementation as edge cases.