anwesenheit: setPresence

Namespace: microsoft.graph

Legen Sie den Status der Anwesenheitssitzung eines Benutzers als Anwendung fest.

Anwesenheitssitzungen

Ein Benutzer kann mehrere Anwesenheitssitzungen haben, da sich der Benutzer auf mehreren Teams Clients (Desktop, Mobil und Web) befindet. Jeder Teams-Client verfügt über eine unabhängige Anwesenheitssitzung, und die Anwesenheit des Benutzers ist ein aggregierter Zustand aus allen Sitzungen, die zurückliegen.

Ebenso kann eine Anwendung eine eigene Anwesenheitssitzung für einen Benutzer haben und den Status aktualisieren.

Es folgt die Rangfolge für die Zusammenfassung von Sitzungszuständen:

• Vom Benutzer konfigurierte > app-konfiguriert (durch den Benutzer konfigurierter Zustand setzt andere außer Kraft)
• Unter app-konfiguriert: DoNotDisturb (derzeit nicht für festgelegte Anwesenheitsinformationen unterstützt) > Beschäftigt > Verfügbar > Abwesend

Timeout, Ablauf und Keep Alive

Bei einer Anwesenheitssitzung kann ein Timeout auftreten und ablaufen, sodass die Anwendung diese API vor dem Timeout aufrufen muss, um den Status für die Sitzung aufrechtzuerhalten. oder vor ablaufen, um die Sitzung aktiv zu halten.

Bei einer Anwesenheitssitzung kann ein Timeout auftreten, wenn die Verfügbarkeit Available und das Timeout 5 Minuten beträgt. Wenn es zu einem Zeitauslass kommt, wird der Anwesenheitszustand phasenweise ausgeblendet. Wenn beispielsweise eine Anwendung die Anwesenheitssitzung als Available/Availablefestlegt, würde sich der Status in 5 Minuten mit dem ersten Timeout ändern Available/AvailableInactive , dann Away/Away in weiteren 5 Minuten mit dem zweiten Timeout.

Der Ablauf einer Anwesenheitssitzung ist mit dem expirationDuration Parameter konfigurierbar. Wenn eine Sitzung abläuft, wird sie zu Offline.

Berechtigungen

Die folgende Berechtigung ist erforderlich, um die API aufzurufen. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	Presence.ReadWrite
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt.
Anwendung	Presence.ReadWrite.All

HTTP-Anforderung

POST /users/{userId}/presence/setPresence

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich.
Content-Type	application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

Parameter	Typ	Beschreibung
Sessionid	Zeichenfolge	Die ID der Anwesenheitssitzung der Anwendung.
availability	Zeichenfolge	Die Basis-Anwesenheitsinformationen.
Aktivität	Zeichenfolge	Die ergänzenden Informationen zur Verfügbarkeit.
expirationDuration	Dauer	Der Ablauf der App-Anwesenheitssitzung. Der Wert wird für Dauer im ISO 8601-Format dargestellt. Wenn nicht angegeben, wird ein Standardmäßiger Ablauf von 5 Minuten angewendet. Der gültige Dauerbereich beträgt 5-240 Minuten (PT5M bis PT4H)

Wichtig

Geben Sie die ID der Anwendung wie sessionId in der Anforderung an.

Unterstützte Kombinationen von availability und activity sind:

availability	Aktivität	Beschreibung
Verfügbar	Verfügbar	Aktualisiert die Anwesenheitssitzung als verfügbar.
Gebucht	InACall	Aktualisiert die Anwesenheitssitzung als beschäftigt, InACall.
Gebucht	InAConferenceCall	Aktualisiert die Anwesenheitssitzung als "Beschäftigt", "InAConferenceCall".
Weg	Weg	Aktualisiert die Anwesenheitssitzung als "Abwesend".

Antwort

Wenn die Methode erfolgreich verläuft, wird der Antwortcode 200 OK zurückgegeben.

Beispiele

Die folgende Anforderung zeigt die Anwendung mit der ID 22553876-f5ab-4529-bffb-cfe50aa89f87 , die ihre Anwesenheitssitzung für den Benutzer fa8bf3dc-eca7-46b7-bad1-db199b62afc3festlegt.

Anforderung

HTTP

POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence
Content-Type: application/json

{
  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87",
  "availability": "Available",
  "activity": "Available",
  "expirationDuration": "PT1H"
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var sessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87";

var availability = "Available";

var activity = "Available";

var expirationDuration = new Duration("PT1H");

await graphClient.Users["{user-id}"].Presence
    .SetPresence(availability,activity,sessionId,expirationDuration)
    .Request()
    .PostAsync();

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const setPresence = {
  sessionId: '22553876-f5ab-4529-bffb-cfe50aa89f87',
  availability: 'Available',
  activity: 'Available',
  expirationDuration: 'PT1H'
};

await client.api('/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence')
    .version('beta')
    .post(setPresence);

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSString *sessionId = @"22553876-f5ab-4529-bffb-cfe50aa89f87";
payloadDictionary[@"sessionId"] = sessionId;

NSString *availability = @"Available";
payloadDictionary[@"availability"] = availability;

NSString *activity = @"Available";
payloadDictionary[@"activity"] = activity;

NSString *expirationDuration = @"PT1H";
payloadDictionary[@"expirationDuration"] = expirationDuration;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String sessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87";

String availability = "Available";

String activity = "Available";

Duration expirationDuration = DatatypeFactory.newInstance().newDuration("PT1H");

graphClient.users("fa8bf3dc-eca7-46b7-bad1-db199b62afc3").presence()
    .setPresence(PresenceSetPresenceParameterSet
        .newBuilder()
        .withSessionId(sessionId)
        .withAvailability(availability)
        .withActivity(activity)
        .withExpirationDuration(expirationDuration)
        .build())
    .buildRequest()
    .post();

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
sessionId := "22553876-f5ab-4529-bffb-cfe50aa89f87"
requestBody.SetSessionId(&sessionId)
availability := "Available"
requestBody.SetAvailability(&availability)
activity := "Available"
requestBody.SetActivity(&activity)
expirationDuration := "PT1H"
requestBody.SetExpirationDuration(&expirationDuration)
userId := "user-id"
graphClient.UsersById(&userId).Presence().SetPresence(user-id).Post(requestBody)

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

PowerShell

Import-Module Microsoft.Graph.Users.Actions

$params = @{
    SessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87"
    Availability = "Available"
    Activity = "Available"
    ExpirationDuration = "PT1H"
}

Set-MgUserPresence -UserId $userId -BodyParameter $params

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Antwort

HTTP/1.1 200 OK