Released in 1.47.
Sets the online status of the calling user.
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 |
|---|---|---|---|
| Green dot |
| Released in 1.46 |
| Yellow clock |
| Released in 1.46 |
| Red circle |
| Released in 1.46 |
| Red phone |
| Released in 1.46 |
| Yellow clock |
| Released in 1.47 |
| Red circle |
| Released in 1.47 |
| Gray circle |
| Released in 1.47 |
| Yellow clock |
| Released in 1.47 |
| Red circle |
| Released in 1.52 |
Visual reference for online status values
Note that:
- Internal users are internal to your company.
- External users are external to your company.
When an internal user has a particular presence category, external users see a value that is a subset of the possible internal values. The table above shows the corresponding External view value for a specific Presence category value. For example, if an internal user's presence is IN_A_MEETING, this internal user appears as AWAY to any external user.
Idle state
When the end-user is idle on the Symphony clients and either in
AVAILABLEorBUSYcategories, the online status of the user is automatically changed toAWAY. 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.