presence: setPresence

Статья
08/23/2023

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Задайте состояние доступности и действий в сеансе присутствия приложения для пользователя.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Сеансы присутствия

У пользователя может быть несколько сеансов присутствия, так как он может находиться в нескольких клиентах Teams (настольных, мобильных и веб-). Каждый клиент Teams имеет независимый сеанс присутствия, и присутствие пользователя является агрегированным состоянием из всех сеансов позади.

Аналогичным образом приложение может иметь собственный сеанс присутствия для пользователя и иметь возможность обновлять состояние.

Ниже приведен приоритет агрегирования состояний сеанса, при этом "A > B" представляет A, имеющий приоритет над B:

Пользовательские состояния > на уровне сеанса (предпочитаемое пользователем состояние переопределяет состояния на уровне сеанса)
Среди состояний на уровне сеанса: DoNotDisturb > Busy > Available Away >

Примечание: При изменении присутствия пользователя в Microsoft Graph, так как клиент Teams использует режим опроса, обновление состояния присутствия займет несколько минут.

Время ожидания, истечение срока действия и сохранение активности

Время ожидания сеанса присутствия может истекать и истекать, поэтому приложению необходимо вызвать этот API до истечения времени ожидания, чтобы сохранить состояние сеанса; или до истечения срока действия, чтобы сохранить сеанс в активном режиме.

Время ожидания сеанса присутствия может истекло, если доступность — Available и время ожидания составляет 5 минут. Когда время ожидания истекает, состояние присутствия исчезает поэтапно. Например, если приложение задает для сеанса Available/Availableприсутствия значение , состояние изменится на Available/AvailableInactive 5 минут с первым тайм-аутом, а затем Away/Away еще через 5 минут со вторым тайм-аутом.

Срок действия сеанса присутствия можно настроить с помощью expirationDuration параметра . По истечении срока действия сеанса он становится Offline.

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Presence.ReadWrite	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	Presence.ReadWrite.All	Недоступно.

HTTP-запрос

POST /users/{userId}/presence/setPresence

Заголовки запроса

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.

Параметр	Тип	Описание
Sessionid	string	Идентификатор сеанса присутствия приложения.
availability	string	Базовые сведения о присутствии.
действие	string	Дополнительные сведения о доступности.
expirationDuration	duration	Истечение срока действия сеанса присутствия приложения. Значение представлено в формате ISO 8601 для длительности. Если этот параметр не указан, будет применен срок действия по умолчанию в 5 минут.

Важно!

Укажите идентификатор приложения, как sessionId в запросе.

Поддерживаемые сочетания и availabilityactivity :

availability	действие	Описание
Доступно	Доступно	Обновления сеанс присутствия значение Доступно.
Занята	InACall	Обновления сеанс присутствия как Занят, InACall.
Занята	InAConferenceCall	Обновления сеанс присутствия значение Занято, InAConferenceCall.
Прочь	Прочь	Обновления сеанс присутствия как "Нет".
DoNotDisturb	Представления	Обновления сеанс присутствия: DoNotDisturb, Presenting.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK.

Примеры

В следующем запросе отображается приложение с идентификатором 22553876-f5ab-4529-bffb-cfe50aa89f87 , который задает сеанс присутствия для пользователя fa8bf3dc-eca7-46b7-bad1-db199b62afc3.

Запрос

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"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Users.Item.Presence.SetPresence;

var requestBody = new SetPresencePostRequestBody
{
	SessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87",
	Availability = "Available",
	Activity = "Available",
	ExpirationDuration = TimeSpan.Parse("PT1H"),
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Users["{user-id}"].Presence.SetPresence.PostAsync(requestBody);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users presence set-presence post --user-id {user-id} --body '{\
  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87",\
  "availability": "Available",\
  "activity": "Available",\
  "expirationDuration": "PT1H"\
}\
'

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphusers.NewSetPresencePostRequestBody()
sessionId := "22553876-f5ab-4529-bffb-cfe50aa89f87"
requestBody.SetSessionId(&sessionId) 
availability := "Available"
requestBody.SetAvailability(&availability) 
activity := "Available"
requestBody.SetActivity(&activity) 
expirationDuration , err := abstractions.ParseISODuration("PT1H")
requestBody.SetExpirationDuration(&expirationDuration) 

graphClient.Users().ByUserId("user-id").Presence().SetPresence().Post(context.Background(), requestBody, nil)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.users.item.presence.setpresence.SetPresencePostRequestBody setPresencePostRequestBody = new com.microsoft.graph.beta.users.item.presence.setpresence.SetPresencePostRequestBody();
setPresencePostRequestBody.setSessionId("22553876-f5ab-4529-bffb-cfe50aa89f87");
setPresencePostRequestBody.setAvailability("Available");
setPresencePostRequestBody.setActivity("Available");
PeriodAndDuration expirationDuration = PeriodAndDuration.ofDuration(Duration.parse("PT1H"));
setPresencePostRequestBody.setExpirationDuration(expirationDuration);
graphClient.users().byUserId("{user-id}").presence().setPresence().post(setPresencePostRequestBody);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


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);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SetPresencePostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SetPresencePostRequestBody();
$requestBody->setSessionId('22553876-f5ab-4529-bffb-cfe50aa89f87');
$requestBody->setAvailability('Available');
$requestBody->setActivity('Available');
$requestBody->setExpirationDuration(new \DateInterval('PT1H'));

$graphServiceClient->users()->byUserId('user-id')->presence()->setPresence()->post($requestBody)->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


Import-Module Microsoft.Graph.Beta.Users.Actions

$params = @{
	sessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87"
	availability = "Available"
	activity = "Available"
	expirationDuration = "PT1H"
}

Set-MgBetaUserPresence -UserId $userId -BodyParameter $params

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


from msgraph import GraphServiceClient
from msgraph.generated.models.set_presence_post_request_body import SetPresencePostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = SetPresencePostRequestBody(
	session_id = "22553876-f5ab-4529-bffb-cfe50aa89f87",
	availability = "Available",
	activity = "Available",
	expiration_duration = "PT1H",
)

await graph_client.users.by_user_id('user-id').presence.set_presence.post(request_body)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

HTTP/1.1 200 OK

presence: setPresence

Сеансы присутствия

Время ожидания, истечение срока действия и сохранение активности

Разрешения

HTTP-запрос

Заголовки запроса

Текст запроса

Отклик

Примеры

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы