Edit

Share via

presence resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Contains information about a user's presence, including their availability and user activity.

Note: This resource is currently only supported for Microsoft Teams users.

This resource supports subscribing to change notifications.

Methods

Method Return Type Description
Get presence presence Get a user's presence information.
Get presence for multiple users presence collection Get the presence information for multiple users.
Set presence Set the availability and activity status in a presence session of an application for a user.
Clear presence Clear a presence session of an application for a user.
Set user preferred presence Set the preferred availability and activity status for a user.
Clear user preferred presence Clear the preferred availability and activity status for a user.
Set user status message Set a presence status message for a user.

Properties

Property Type Description
activity String collection The supplemental information to a user's availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.
availability String collection The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.
id String The unique identifier for the user.
outOfOfficeSettings outOfOfficeSettings The out of office settings for a user.
statusMessage presenceStatusMessage The presence status message of a user.

Note: To learn more about the different presence states, see User presence in Teams.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
   "activity": "String",
   "availability": "String",
   "id": "String (identifier)",
   "outOfOfficeSettings": {"@odata.type": "#microsoft.graph.outOfOfficeSettings"},
   "statusMessage": {"@odata.type": "#microsoft.graph.presenceStatusMessage"}
}