Ссылка API REST фото пользователя Outlook (версия 2.0)

  • Статья

Применимо к: Exchange Online | Office 365** **

Фотография пользователя API позволяет загружать или устанавливать фотографию пользователя, почтовый ящик которого защищен директорией Azure Active Directory в Office 365.

Примечание

API для фото пользователя не поддерживает почтовые ящики пользователей в доменах учетных записей Microsoft, таких как Hotmail.com, Live.com, MSN.com, Outlook.com и Passport.com.

Не заинтересованы в API версии 2.0? В оглавлении слева, перейдите к разделу Ссылка API REST Office 365 и выберите нужную версию.

Использование фотографии пользователя REST API

Проверка подлинности

Как и другие API REST Outlook, для каждого запроса к Outlook фотографии пользователя API, вам следует включить действительный маркер доступа. Получение маркера доступа требует, чтобы вы зарегистрировались и идентифицировали свое приложение и получили соответствующее разрешение.

Узнайте больше о некоторых упрощенных параметрах регистрации и авторизации. Помните об этом, когда выполняете конкретные действия в фотографии пользователя API.

Версия API

Этот API был повышен с предварительной версии до общедоступной версии. Он поддерживается в версиях v2.0 и бета-версиях REST API Outlook.

Целевой пользователь

Целевой пользователь может быть пользователем с подписью или пользователем, указанным идентификатором пользователя.

Для получения дополнительной информации с помощью этого API и информации, общей для всех подмножеств API REST Outlook, см. Использовать API REST Outlook.

Операции фото пользователя

Операции с фотографиями пользователей позволяют вам получать метаданные и поток фотографий пользователя в двоичном формате и устанавливать фотографию пользователя.

Получить метаданные фотографий

Получите информацию о запрошенной фотографии пользователя, которая включает в себя тип контента, eTag, а также ширину и высоту в пикселях.

Требуемая область

Используйте одну из следующих областей для получения метаданных фотографии указанного пользователя, который может быть пользователем, выполнившим вход:

  • user.readbasic.all
  • user.read.all
  • user.readwrite.all

Вы также можете использовать следующую область для получения метаданных фотографий именно пользователя, выполнившего вход:

  • user.read

Получить метаданные для самой большой доступной фотографии

GET https://outlook.office.com/api/v2.0/me/photo
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo
Необязательный параметр Тип Описание
Параметры URL-адреса
user_id строка Электронный адрес пользователя.

Пример запроса

Этот запрос возвращает метаданные фотографии вошедшего пользователя.

GET https://outlook.office.com/api/v2.0/me/photo

Пример данных ответа

Следующие данные ответа показывают метаданные фотографии. Код HTTP-ответа: 200.

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "@odata.mediaEtag": "\"BA09D118\"",
    "Id": "240X240",
    "Width": 240,
    "Height": 240
}

Следующие данные ответа показывают содержимое ответа, когда фотография еще не была загружена для пользователя. Код HTTP-ответа: 200.

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/gif",
    "@odata.mediaEtag": "",
    "Id": "1X1",
    "Width": 1,
    "Height": 1
}

Получение фотографии

Получите фотографию пользователя указанного пользователя.

Эта операция позволяет администратору-арендатору разрешить приложению получать фотографию пользователя любого пользователя в аренде.

Требуемая область

Используйте одну из следующих областей для получения фотографии указанного пользователя, который может быть пользователем, выполнившим вход:

  • user.readbasic.all
  • user.read.all
  • user.readwrite.all

Вы также можете использовать следующую область для получения метаданных фотографий специально для входа пользователя:

  • user.read
  • user.readwrite

Получите самый большой доступный размер

GET https://outlook.office.com/api/v2.0/me/photo/$value
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo/$value
Необязательный параметр Тип Описание
Параметры URL-адреса
user_id строка Электронный адрес пользователя.

Пример запроса

Этот запрос получает фотографию для пользователя, выполнившего вход.

GET https://outlook.office.com/api/v2.0/me/photo/$value
Content-Type: image/jpg

Данные в ответе

Содержит двоичные данные запрошенной фотографии. Код HTTP-отклика: 200.

Установить фото пользователя

Назначьте фотографию зарегистрированному пользователю. Фотография должна быть в двоичном формате. Она заменяет любую существующую фотографию для этого пользователя.

Вы можете использовать PATCH или PUT для этой операции в версии 2.0.

Требуемая область

Для установки фотографии пользователя, выполнившего вход, используйте следующую область:

  • user.readwrite
PATCH https://outlook.office.com/api/v2.0/me/photo/$value
PATCH https://outlook.office.com/api/v2.0/users('{user_id}')/photo/$value

PUT https://outlook.office.com/api/v2.0/me/photo/$value
PUT https://outlook.office.com/api/v2.0/users('{user_id}')/photo/$value
Необязательный параметр Тип Описание
Параметры URL-адреса
user_id строка Электронный адрес пользователя.

Пример запроса

PATCH https://outlook.office.com/api/v2.0/me/photo/$value
Content-Type: image/jpeg

Включите двоичные данные фотографии в текст запроса.

Данные в ответе

Успешный запрос возвращает HTTP 200.

Дальнейшие действия

Независимо от того, готовы ли вы приступить к созданию приложения или хотите изучить больше материалов, у нас есть все необходимое.

Или узнайте больше об использовании платформы Office 365 здесь: