cloudCommunications: getPresencesByUserId

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

Получение сведений о присутствии для нескольких пользователей.

Примечание: Этот API позволяет пользователям подписываться только на присутствие другого пользователя. Если приложение хочет подписаться на сведения о присутствии для всех пользователей, оно использует вымышленных пользователей для создания подписки для сбора необходимых данных.

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

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

Разрешения

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

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

Примечание.

  • На запрос API поддерживается не более 650 идентификаторов пользователей.
  • Максимальная частота запросов этого API составляет 1500 запросов API за 30-секундный период на каждое приложение на клиент.

HTTP-запрос

POST /communications/getPresencesByUserId

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

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

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

В тексте запроса укажите объект JSON со следующим параметром.

Параметр Тип Описание
ids Коллекция String Идентификаторы объектов пользователя.

Отклик

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

Примеры

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/v1.0/communications/getPresencesByUserId
Content-Type: application/json

{
	"ids": ["fa8bf3dc-eca7-46b7-bad1-db199b62afc3", "66825e03-7ef5-42da-9069-724602c31f6b"]
}

Отклик

Ниже показан пример отклика.

Примечание: Объекты ответа могут быть сокращены для удобства чтения. При фактическом вызове будут возвращены все свойства.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1574

{
	"value": [{
			"id": "fa8bf3dc-eca7-46b7-bad1-db199b62afc3",
			"availability": "Busy",
			"activity": "InAMeeting"
		},
		{
			"id": "66825e03-7ef5-42da-9069-724602c31f6b",
			"availability": "Away",
			"activity": "Away"
		}
	]
}