Set Presence

Sets the online status of the calling user.

Set the presence of the requesting user.

post

Query parameters

softbooleanOptional

If true, the user's current status is taken into consideration. If the user is currently OFFLINE, the user's presence will still be OFFLINE, but the new presence will take effect when the user comes online. If the user is currently online, the user's activity state will be applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE, but the user is currently idle, their status will be represented as AWAY)

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

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

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

post

/v2/user/presence

HTTPcURLJavaScriptPython

POST /pod/v2/user/presence HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "category": "AWAY"
}

{
  "category": "AWAY",
  "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 are available in Get Presence

📘 Idle state

When the end-user is idle on the Symphony clients and either in AVAILABLE or BUSY categories, the online status of the user is automatically changed to AWAY. When the user is active again on the client, then the online status is automatically changed back to the prior category.

🚧 Roles and Privileges

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