Set Presence

Sets the online status of the calling user.

Set the presence of the requesting user.

POSTyourpodURL.symphony.com/pod/v2/user/presence

Query parameters

Header parameters

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

Response

200400401500

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/v2/user/presence', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "category": "AWAY"
    }),
});
const data = await response.json();

Response

{
  "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.