presence: setPresence
Namespace: microsoft.graph
Set the state of a user's presence session as an application.
Presence sessions
A user can have multiple presence sessions because the user can be on multiple Teams clients (desktop, mobile, and web). Each Teams client has an independent presence session and the user's presence is an aggregated state from all the sessions behind.
Similarly, an application can have its own presence session for a user and be able to update the state.
The following is the precedence for how session states are aggregated:
- User-configured > app-configured (user-configured state overrides others)
- Among app-configured: DoNotDisturb > Busy > Available > Away
Note: When a user presence changes in Microsoft Graph, because the Teams client uses poll mode, it will take a few minutes to update the presence status.
Timeout, expiration, and keep alive
A presence session may time out and expire, so the application needs to call this API before the timeout, to maintain the state for the session; or before the expiration, to keep the session alive.
A presence session can time out if the availability is Available
and the timeout is 5 minutes. When it times out, the presence state fades in stages. For example, if an application sets the presence session as Available/Available
, the state would change to Available/AvailableInactive
in 5 minutes with the first timeout, then Away/Away
in another 5 minutes with the second timeout.
The expiration of a presence session is configurable with the expirationDuration
parameter. When a session expires it becomes Offline
.
Permissions
The following permission is required to call the API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Presence.ReadWrite |
Delegated (personal Microsoft account) | Not Supported. |
Application | Presence.ReadWrite.All |
HTTP Request
POST /users/{userId}/presence/setPresence
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json. Required. |
Request body
In the request body, provide a JSON object with the following parameters.
Parameter | Type | Description |
---|---|---|
sessionId | string | The ID of the application's presence session. |
availability | string | The base presence information. |
activity | string | The supplemental information to availability. |
expirationDuration | duration | The expiration of the app presence session. The value is represented in ISO 8601 format for durations.If not provided, a default expiration of 5 minutes will be applied. The valid duration range is 5-240 minutes (PT5M to PT4H) |
Important
Provide the ID of the application as sessionId
in the request.
Supported combinations of availability
and activity
are:
availability | activity | Description |
---|---|---|
Available | Available | Updates the presence session as Available. |
Busy | InACall | Updates the presence session as Busy, InACall. |
Busy | InAConferenceCall | Updates the presence session as Busy, InAConferenceCall. |
Away | Away | Updates the presence session as Away. |
DoNotDisturb | Presenting | Updates the presence session as DoNotDisturb, Presenting. |
Response
If successful, this method returns a 200 OK
response code.
Examples
The following request shows the application with ID 22553876-f5ab-4529-bffb-cfe50aa89f87
that sets its presence session for user fa8bf3dc-eca7-46b7-bad1-db199b62afc3
.
Request
POST https://graph.microsoft.com/v1.0/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence
Content-Type: application/json
{
"sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87",
"availability": "Available",
"activity": "Available",
"expirationDuration": "PT1H"
}
Response
HTTP/1.1 200 OK
Feedback
Submit and view feedback for