Справочник по API REST для Фото пользователя Outlook (бета)
Применимо к: Exchange Online | Office 365
Примечание
Эта документация охватывает бета-версию API для Фото пользователя API в режиме предварительного просмотра. Параметры предварительного просмотра могут быть изменены до завершения и могут нарушать код, который их использует. Поэтому в своем производственном коде вы должны использовать только производственную версию API. Если она доступна, предпочтительной версией в настоящее время является v2.0.
Фотография пользователя API позволяет загружать или устанавливать фотографию пользователя, почтовый ящик которого защищен директорией Azure Active в Office 365.
Примечание
API для Фото пользователя не поддерживает почтовые ящики пользователей в доменах учетных записей Microsoft, таких как Hotmail.com, Live.com, MSN.com, Outlook.com и Passport.com.
Не интересуетесь бета-версией API? В оглавлении слева перейдите к разделу Справочик по API REST Office 365 и выберите нужную версию.
Использование API REST для Фото пользователя
Проверка подлинности
Как и другие API REST Outlook, для каждого запроса к Outlook фотографии пользователя API, вам следует включить действительный маркер доступа. Получение маркера доступа требует, чтобы вы зарегистрировались и идентифицировали свое приложение и получили соответствующее разрешение.
Узнайте больше о некоторых упрощенных параметрах регистрации и авторизации. Помните об этом, когда выполняете конкретные действия в фотографии пользователя API.
Версия API
Этот API был повышен с предварительной версии до общедоступной версии. Он поддерживается в версиях v2.0 и бета-версиях REST API Outlook.
Целевой пользователь
Целевой пользователь может быть пользователем с подписью или пользователем, указанным идентификатором пользователя.
Для получения дополнительной информации с помощью этого API и информации, общей для всех подмножеств API REST Outlook, см. Использовать API REST Outlook.
Операции с фотографиями пользователей
Операции с фотографиями пользователей позволяют вам получать метаданные и поток фотографий пользователя в двоичном формате и устанавливать фотографию пользователя.
В добавок к Фото, фотография пользователя API предоставляет коллекцию фотографий , которая находится в предварительном просмотре и доступна только в бета-версии. Коллекция фотографий позволяет указать конкретные размеры фотографии пользователя, которая вас интересует.
Получение метаданных фотографий
Получите информацию о запрошенной фотографии пользователя, включая тип содержимого, eTag, а также ширину и высоту в пикселях.
Требуемая область
Используйте одну из следующих областей для получения метаданных фотографии указанного пользователя, который может быть пользователем, выполнившим вход:
- user.readbasic.all
- user.read.all
- user.readwrite.all
Вы также можете использовать следующую область для получения метаданных фотографий именно пользователя, выполнившего вход:
- user.read
Получить метаданные для самой большой доступной фотографии
GET https://outlook.office.com/api/beta/me/photo
GET https://outlook.office.com/api/beta/Users('{user_id}')/photo
Получить метаданные для всех доступных размеров фотографий
GET https://outlook.office.com/api/beta/me/photos
GET https://outlook.office.com/api/beta/Users('{user_id}')/photos
Получить метаданные для определенного размера фотографии
GET https://outlook.office.com/api/beta/me/photos('{size}')
GET https://outlook.office.com/api/beta/Users('{user_id}')/photos('{size}')
| Необязательный параметр | Тип | Описание |
|---|---|---|
| Параметры URL-адреса | ||
| user_id | строка | Адрес электронной почты пользователя. |
| size | строка | Размер фотографии. Значение «1x1» автогенерируется в случае, если фотография отсутствует как в директории Active, так и в почтовом ящике. Если фотография сохранена в почтовом ящике, то предопределенные размеры: «48x48», «64x64», «96x96», «120x120», «240x240», «360x360», «432x432», «504x504» и «648x648» ». Если пользователь не загружает достаточно большое фото, доступны только размеры, которые могут быть представлены меньшими предопределенными размерами. Например, если пользователь загрузит фотографию размером 504 x 504 пикселя, для скачивания будут доступны все размеры, кроме 648 x 648. Фотографии могут быть любого размера, если они хранятся в Active Directory. |
Пример запроса
Этот запрос получает метаданные изображения размером 240 x 240 пикселей для пользователя, выполнившего вход.
GET https://outlook.office.com/api/beta/me/photos('240x240')
Пример данных ответа
Следующие данные ответа показывают метаданные фотографии. Код HTTP-ответа: 200.
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/photo/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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/beta/$metadata#Me/photo/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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/beta/me/photo/$value
GET https://outlook.office.com/api/beta/Users('{user_id}')/photo/$value
Получить фотографию определенного размера
GET https://outlook.office.com/api/beta/me/photos('{size}')/$value
GET https://outlook.office.com/api/beta/Users('{user_id}')/photos('{size}')/$value
| Необязательный параметр | Тип | Описание |
|---|---|---|
| Параметры URL-адреса | ||
| user_id | строка | Адрес электронной почты пользователя. |
| size | строка | Размер фотографии. Значение «1x1» автогенерируется в случае, если фотография отсутствует как в директории Active, так и в почтовом ящике. Если фотография сохранена в почтовом ящике, то предопределенные размеры: «48x48», «64x64», «96x96», «120x120», «240x240», «360x360», «432x432», «504x504» и «648x648» ». Если пользователь не загружает достаточно большое фото, доступны только размеры, которые могут быть представлены меньшими предопределенными размерами. Например, если пользователь загрузит фотографию размером 504 x 504 пикселя, для скачивания будут доступны все размеры, кроме 648 x 648. Фотографии могут быть любого размера, если они хранятся в Active Directory. |
Пример запроса
Этот запрос получает фотографию для пользователя, выполнившего вход.
GET https://outlook.office.com/api/beta/me/photo/$value
Content-Type: image/jpg
Данные ответа
Содержит двоичные данные запрошенной фотографии. Код HTTP-ответа: 200.
Установить фото пользователя
Назначьте фотографию указанному пользователю. Фотография должна быть в двоичном формате. Она заменяет любую существующую фотографию для этого пользователя.
Эта операция позволяет администратору-арендатору разрешить приложению получать фотографию пользователя любого пользователя в аренде. В бета-версии для этой операции следует использовать только PUT.
Требуемая область
Используйте следующую область, чтобы установить фотографию указанного пользователя, который может быть любым пользователем в аренде или вошедшем в систему пользователем:
- user.readwrite.all
Вы можете также использовать следующую область, чтобы установить фотографию специально зарегистрированного пользователя:
- user.readwrite
PUT https://outlook.office.com/api/beta/me/photo/$value
PUT https://outlook.office.com/api/beta/users('{user_id}')/photo/$value
| Необязательный параметр | Тип | Описание |
|---|---|---|
| Параметры URL-адреса | ||
| user_id | строка | Адрес электронной почты пользователя. |
Пример запроса
PUT https://outlook.office.com/api/beta/me/photo/$value
Content-Type: image/jpeg
Включите двоичные данные фотографии в текст запроса.
Данные ответа
Успешный запрос возвращает HTTP 200.
Дальнейшие действия
Независимо от того, готовы ли вы приступить к созданию приложения или хотите изучить больше материалов, у нас есть все необходимое.
- Начало работы с API REST Почты, Календаря и Контактов.
- Хотите увидеть примеры? Вот они.
Или узнайте больше об использовании платформы Office 365 здесь: