Set Presence

Sets the online status of the calling user.
post
https://yourpodURL.symphony.com/pod
/v2/user/presence
Set the presence of the requesting user.
Parameters
Query
soft
string
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
sessionToken*
string
Session authentication token.
Body
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
Body
Example
Schema
{
"category": "AWAY"
}
Responses
200: OK
OK
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
500: Internal Server Error
Server error, see response body for further details.
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.
Last modified 2mo ago