presence: setUserPreferredPresence

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

Задайте предпочтительное состояние доступности и действий для пользователя. Если задано предпочтительное присутствие пользователя, его присутствие отображается в качестве предпочтительного состояния.

Предпочтительное присутствие вступает в силу только в том случае, если для пользователя существует хотя бы один сеанс присутствия . В противном случае присутствие пользователя отображается как Offline.

Сеанс присутствия создается в результате успешной операции setPresence или при входе пользователя в клиент Microsoft Teams.

Дополнительные сведения см. в разделе Сеансы присутствия , время ожидания и истечение срока действия.

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

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

Разрешения

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

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

HTTP-запрос

POST /users/{userId}/presence/setUserPreferredPresence

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

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

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

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

Параметр Тип Описание
действие String Дополнительные сведения о доступности.
availability String Базовые сведения о присутствии.
expirationDuration Duration (Длительность) Срок действия сеанса присутствия приложения, представленного в формате ISO 8601 в течение длительности.
Если этот параметр не указан, будет применен срок действия по умолчанию:
- DoNotDisturb или Busy: срок действия в течение 1 дня
- Все остальные: срок действия за 7 дней

В следующей таблице перечислены поддерживаемые сочетания доступности и действий.

availability действие Описание
Доступно Доступно Задайте для предпочтительного присутствия пользователя значение Available.
Занята Занята Задайте для предпочтительного присутствия пользователя значение Busy.
DoNotDisturb DoNotDisturb Задайте для предпочтительного присутствия пользователя значение DoNotDisturb.
BeRightBack BeRightBack Задайте для предпочтительного присутствия пользователя значение BeRightBack.
Прочь Прочь Задайте для предпочтительного присутствия пользователя значение Away.
Автономный режим OffWork Задайте для предпочтительного присутствия пользователя значение Offline.

Отклик

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

Примеры

Запрос

В следующем примере показан запрос, который задает предпочтительное присутствие DoNotDisturb для пользователя со сроком действия 8 часов.

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

{
  "availability": "DoNotDisturb",
  "activity": "DoNotDisturb",
  "expirationDuration": "PT8H"
}

Отклик

Ниже приводится пример отклика.

HTTP/1.1 200 OK