Set Other User's Presence - Admin

Sets the presence state of a another user.

Set presence information for a particular 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

userIdinteger · int64Optional

The ID of the user to whom the presence state relates.

Example: 14568529068038

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

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

Not Found: user id cannot be located.

application/json

500

Server error, see response body for further details.

application/json

post/v3/user/presence

HTTPcURLJavaScriptPython

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

{
  "category": "AWAY",
  "userId": 14568529068038
}

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

🚧 User role requirement

To set the presence of another user, this endpoint requires to be called by a service user with the "User Provisioning" Entitlement.