Ссылка на API ресурс для Почты, Календаря, Контактов и Задач REST (версия 1.0)
Применимо к: Онлайн обмену | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Примечание
API REST Outlook версии 1.0 является устаревшим. Начиная с 1 ноября 2018 г. приложения не смогут использовать обычную проверку подлинности с конечной точкой v1.0 REST. К 1 ноября 2019 г. конечная точка v1.0 REST будет полностью выведена из эксплуатации, а вскоре после этого будет удалена документация v1.0. Запустите миграцию приложения, чтобы использовать API REST Outlook в версии 1.0 Microsoft Graph. Дополнительные сведения смотрите в нашем объявлении.
В этой статье описываются объекты API REST, свойства, сложные типы, перечисления и параметры запросов OData, которые можно использовать с API для Outlook почты, календаря, контактов и задач, чтобы получить доступ к данным почтового ящика пользователя в Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com и Passport.com.
Примечание
Для упрощения справочной информации в остальной части этой статьи при упоминании «Outlook.com» также подразумеваются и эти домены учетной записи Microsoft.
Дополнительные сведения, общие для всех подмножества API REST Outlook, смотрите в Использование API REST Outlook.
Не интересуетесь API версии 1.0? В оглавлении слева, перейдите к разделу Справочник по API REST Office 365 и выберите нужную версию.
Совет
Вы можете просмотреть полный документ метаданных для модели данных объекта Почта, Календарь, Контакты и Задача, перейдя в конечную точку $metadata в веб-браузере (пример: https://outlook.office.com/api/v1.0/$metadata).
Вложение
Файл или элемент (контакт, событие или сообщение), прикрепленный к мероприятию или сообщению. -
соответствующийприкрепленный файл и прикрепленный элемент являются производными ресурса прикрепления.
Тип:Microsoft. Службы Outlook.Объект
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| Тип контента | Строка | MIME тип вложения. | Да | Нет |
| Встроеное | Boolean (логический) | true если вложение является встроенным; в противном случае, false. |
Да | Да |
| Последнее изменение Даты и Времени | Коррекция Даты и Времени | Дата и время последнего изменения вложения. Дата и время используют формат ISO 8601 и всегда имеют часовой пояс UTC. Например, полночь в часовом поясе UTC 1 января 2014 г. будет выглядеть следующим образом: «2014-01-01T00:00:00Z» |
Нет | Да |
| Имя | Строка | Отображаемое имя вложения. Оно не обязательно должно быть фактическим именем файла. | Да | Да |
| Размер | Int32 | Размер вложения в байтах. | Нет | Нет |
Календарь
Календарь, служит контейнером для событий.
Тип: Microsoft.Службы Outlook.Календарь
Коллекция Календарь возвращает массив календарей в значение свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/calendars/$count
Информацию о поддерживаемых действиях смотрите в Операции с Календарем.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| Имя | Строка | Имя календаря. | Да | Да |
| Клавиша изменения | Строка | Идентифицирует версию объекта календаря. При каждом изменении календаря свойство ChangeKey также меняется. Это позволяет программе Exchange применять изменения к правильной версии объекта. | Нет | Нет |
| Цвет | CalendarColor | Задает цветовую тему, отличающую этот календарь от других календарей в пользовательском интерфейсе. Значения свойств: LightBlue = 0, LightGreen = 1, LightOrange = 2, LightGray = 3, LightYellow = 4, LightTeal = 5, LightPink = 6, LightBrown = 7, LightRed = 8, MaxColor = 9, Auto = -1. | Да | Да |
| Id | Строка | Уникальный идентификатор календаря. | Нет | Нет |
| CalendarView | Коллекция (Event) | Представление календаря для календаря. Свойство навигации. | Нет | Нет |
| События | Коллекция (Событие) | События в календаре. Свойство навигации. | Нет | Нет |
Группа календаря
Группа календарей.
Примечание
Outlook.com поддерживает только группу календарей по умолчанию, которая доступна по ../me/calendars ссылке. Вы не можете удалить эту группу календарей.
Тип: Microsoft.OutlookServices.CalendarGroup
Коллекция Группа календаря возвращает массив групп календарей в значение свойства OData ответа. Для подсчета объектов в коллекции используйте $count: .../me/calendargroups/$count
Информацию о поддерживаемых действиях смотрите в Операции с Группой календаря.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| Имя | Строка | Имя группы. | Да | Да |
| Клавиша изменения | Строка | Идентифицирует версию группы календарей. При каждом изменении группы календарей свойство ChangeKey также меняется. Это позволяет программе Exchange применять изменения к правильной версии объекта. | Нет | Нет |
| ClassId | Строка | Идентификатор класса. | Нет | Да |
| Id | Строка | Уникальный идентификатор группы календарей. | Нет | Нет |
| Календари | Коллекция (Календарь) | Календари в группе календарей. Свойство навигации. | Нет | Нет |
Контакт
Контакт, который является элементом Outlook для организации и сохранения пользователями информации о людях и организациях, с которыми они общаются. Контакты содержатся в папках контактов.
Тип: Microsoft.OutlookServices.Contact
Коллекция Контакт возвращает массив контактов в свойстве значения свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/contacts/$count
Информацию о поддерживаемых действиях смотрите в Операции с контактами.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| Имя ассистента | Строка | Имя ассистента контакта. | Да | Да |
| День рождения | datetimeoffset | День рождения контакта. | Да | Да |
| Рабочий адрес | PhysicalAddress | Рабочий адрес контакта. | Да | Да |
| BusinessHomePage | Строка | Рабочая домашняя страница контакта. | Да | Да |
| Рабочие телефоны | Collection(String) | Рабочие номера телефонов контакта. | Да | Нет |
| Категории | Collection(String) | Категории, связанные с контактом. | Да | Нет |
| Клавиша изменения | Строка | Идентифицируют версию контакта. При каждом изменении контакта свойство ChangeKey также меняется. Это позволяет программе Exchange применять изменения к правильной версии объекта. | Нет | Нет |
| Children | Коллекция (Строка) | Имена детей контакта. | Да | Да |
| Название компании | Строка | Название компании контакта. | Да | Да |
| Department | Строка | Отдел контакта. | Да | Да |
| DateTimeCreated | коррекция даты, времени | Время создания контакта. | Нет | Да |
| DateTimeLastModified | datetimeoffset | Время изменения контакта. | Нет | Да |
| DisplayName | Строка | Отображаемое имя контакта. | Да | Да |
| Адрес электронной почты | Коллекция (EmailAddress) | Адреса электронной почты контакта. | Да | Нет |
| FileAs | Строка | Имя, под которым хранится контакт. | Да | Да |
| Генерация | Строка | Генерация контакта. | Да | Да |
| GivenName | Строка | Личное имя контакта. | Да | Да |
| Домашний адрес | PhysicalAddress | Домашний адрес контакта. | Да | Да |
| HomePhones | Коллекция (Строка) | Номера домашних телефонов контакта. | Да | Нет |
| Id | Строка | Уникальный идентификатор контакта. | Нет | Нет |
| ImAddresses | Коллекция (Строка) | Адреса контакта для обмена мгновенными сообщениями (IM). | Да | Нет |
| Инициалы | Строка | Инициалы контакта. | Да | Да |
| JobTitle | Строка | Должность контакта. | Да | Да |
| Руководитель | Строка | Имя руководителя контакта. | Да | Да |
| MiddleName | Строка | Отчество контакта. | Да | Да |
| MobilePhone1 | Строка | Номер мобильного телефона контакта. | Да | Да |
| Прозвище | Строка | Прозвище контакта. | Да | Да |
| Расположение офиса | Строка | Расположение офиса контакта. | Да | Да |
| MobilePhone1 | PhysicalAddress | Другие адреса контакта. | Да | Да |
| ParentFolderId | Строка | Идентификатор родительской папки контакта. | Нет | Нет |
| PersonalNotes | Строка | Заметки пользователя о контакте. | Да | Да |
| Профессия | Строка | Профессия контакта. | Да | Да |
| Имя супруга(и) | Строка | Имя супруга или супруги контакта. | Да | Да |
| Фамилия | Строка | Фамилия контакта. | Да | Да |
| Звание | Строка | Должность контакта. | Да | Нет |
| YomiCompanyName | Строка | Название компании контакта записанное так, как оно звучит по-японски. Это свойство является необязательным. | Да | Нет |
| YomiGivenName | Строка | Имя контакта, записанное так, как оно звучит по-японски. Это необязательное свойство. | Да | Нет |
| Yomi Фамилия | Строка | Фамилия контакта, записанная так, как она звучит по-японски. Это необязательное свойство. | Да | Нет |
ContactFolder
Папка, содержащая контакты.
Тип: Microsoft.OutlookServices.ContactFolde
Коллекция Папка контакта возвращает массив папок контактов в value свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/contactfolders/$count
Информацию о поддерживаемых действиях смотрите в ContactFolder operations.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| ChildFolders | Collection(ContactFolder) | Коллекция дочерних папок в папке. Свойство навигации. | Нет | Нет |
| Контакты | Коллекция (Contact) | Контакты в папке. Свойство навигации. | Нет | Нет |
| DisplayName | Строка | Отображаемое имя папки. | Да | Да |
| Id | Строка | Уникальный идентификатор папки с контактами. | Нет | Нет |
| ParentFolderId | Строка | Идентификатор родительской папки для папки. | Нет | Нет |
Событие
Событие в календаре.
Тип: Microsoft.Службы Outlook.Событие
Коллекция Событие возвращает массив событий в value свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/events/$count
Информацию о поддерживаемых действиях смотрите в Event operations.
| Свойство | Тип | Описание | Записываемый? | Фильтруемый? |
|---|---|---|---|---|
| Вложения | Collection(Attachment) | Коллекция вложений FileAttachment и ItemAttachment для события. Свойство навигации. | Нет | Нет |
| Участники | Коллекция(Attendee) | Коллекция участников события. | Да | Нет |
| Текст | ItemBody | Текст сообщения, связанного с событием. | Да | Нет |
| BodyPreview | Строка | Предварительный просмотр сообщения, связанного с событием. | Нет | Нет |
| Календарь | Календарь | Календарь, содержащий событие. Свойство навигации. | Нет | Нет |
| Категории | Collection(String) | Категории, связанные с событием. | Да | Нет |
| Клавиша изменения | Строка | Указывает версию объекта события. При каждом изменении события также меняется значение ChangeKey. Благодаря этому Exchange может применять изменения к правильной версии объекта. | Нет | Нет |
| DateTimeCreated | datetimeoffset | Дата и время создания события. | Нет | Да |
| DateTimeLastModified | datetimeoffset | Дата и время последнего изменения события. | Нет | Да |
| Конец | datetimeoffset | Дата и время завершения события. По умолчанию время завершения указано в формате UTC. Можно дополнительно указать часовой пояс в элементе EndTimeZone, задать время завершения согласно этому часовому поясу и UTC-смещение. Обратите внимание, что если вы используете EndTimeZone, следует также указать значение StartTimeZone. Пример указывает 25 февраля 2015 г., 21:34 по тихоокеанскому поясному времени: "2015-02-25T21:34:00-08:00". |
Да | Да |
| EndTimeZone | Строка | Указывает часовой пояс собрания на момент времени окончания собрания (см. свойство Конец). Это свойство задается с названием часового пояса, поскольку оно хранится в Windows. Вы можете получить имена часовых поясов, вызвав System.TimeZoneInfo.GetSystemTimeZones (). Это свойство необязательно для версии 1.0. Однако это свойство должно использоваться, если используется свойство StartTimeZone. Для получения дополнительной информации см. TimeZone. |
Да | Нет |
| HasAttachments | логический | Задайте "верно", если у события есть вложения. | Нет | Да |
| Идентификатор | Строка | Уникальный идентификатор события. | Нет | Нет |
| Важность | Важность | Важность события: Low, Normal, High. |
Да | Да |
| Экземпляры | Коллекция (Event) | Экземпляры события. Свойство навигации. | Нет | Нет |
| iCalUID | Строка | Уникальный идентификатор, совместно используемый всеми экземплярами события в разных календарях. | Нет | Да |
| IsAllDay | логический | Задайте "верно", если событие длится весь день. Для настройки этого свойства необходимо настроить свойства Start и End события. | Да | Да |
| IsCancelled | логический | Задайте "верно", если событие отменено. | Да | Да |
| Организатор | логическое значение | Задайте "верно", если отправитель сообщения также является его организатором. | Да | Да |
| Местоположение | Местоположение | Место проведения события. | Да | Да |
| Организатор | Получатель | Организатор события. | Да | Да |
| Повторение | Шаблонная Повторяемость | Расписание повторения события. | Да | Нет |
| ResponseRequested | логический | Задайте "верно", если отправитель желает получить сообщение о согласии или отказе участвовать в событии. | Да | Да |
| ResponseStatus | ResponseStatus | Указывает тип ответа, отправленного в ответ на сообщение о событии. | Нет | Да |
| Чувствительность | Чувствительность | Указывает уровень конфиденциальности события: Нормальный = 0, Персональный = 1, Личный = 2, Конфиденциальный = 3. | Да | Да |
| Идентификатор мастера серии | Строка | Категории, назначенные элементу. | Да | Нет |
| ShowAs | FreeBusyStatus | Отображаемое состояние. Свободен = 0, Предварительно= 1, Занят = 2, Не удобно= 3, Работаю в другом месте = 4, Неизвестно = -1. | Да | Да |
| Начало | коррекция даты, времени | Время начала события. По умолчанию время начала указано в формате UTC. Можно дополнительно указать часовой пояс в элементе StartTimeZone, задать время завершения согласно этому часовому поясу и UTC-смещение. Обратите внимание, что если вы используете StartTimeZone, следует также указать значение EndTimeZone. Пример указывает 25 февраля 2015 г., 19:34 по тихоокеанскому поясному времени: "2015-02-25T19:34:00-08:00". |
Да | Да |
| Часовой пояс Начала | Строка | Указывает часовой пояс собрания для времени начала собрания (см. свойство "Начало"). Это свойство позволяет сделать так, чтобы изменения часового пояса обрабатывались службой, а не клиентом. Это свойство задается с названием часового пояса, поскольку оно хранится в Windows. Вы можете получить имена часовых поясов, вызвав System.TimeZoneInfo.GetSystemTimeZones (). Это свойство необязательно для версии 1.0. Однако это свойство должно использоваться, если используется свойство EndTimeZone. Примерное значение для этого свойства: «Стандартное тихоокеанское время». Для получения дополнительной информации см. TimeZone. |
Да | Нет |
| Тема | Строка | Текст в строке темы события. | Да | Да |
| Тип | Тип События | Тип события: Единичный случай= 0, Частота = 1, Исключение = 2, SeriesMaster = 3. | Да | Да |
| WebLink | Строка | URL-адрес для открытия события в Outlook Web App. Событие откроется в браузере, если вы вошли в свой почтовый ящик с помощью Outlook Web App. Если вход с помощью браузера еще не выполнен, вам будет предложено войти. Доступ к этому URL-адресу можно получить из iFrame. |
Нет | Нет |
EventMessage
Сообщение, которое представляет собой приглашение на собрание, оповещение о принятии (в том числе предварительном) или отклонении такого приглашения, оповещение об отмене собрания.
Базовый тип: Сообщение
Экземпляр EventMessage обычно находится в папке «Входящие», где он появляется в результате создания собрания организатором события или в результате ответа участника на запрос о присоединении к собранию. Вы воздействуете на сообщения о событиях так же, как и на тип Message, с некоторыми незначительными отличиями, описанными в следующей таблице.
| Action/Verb | Разрешение | Описание |
|---|---|---|
| Создать сообщение о событии (POST) | Н/Д | Запрещено. В результате отобразится код отклика 400. |
| Обновить сообщение события (PATCH) | Почта.Написать | Вы можете обновить свойства From, Sender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Subject, Body, Importance и Categories. |
| Удалить сообщение события (DELETE) | Mail.Write | То же действие, что и для Сообщения. |
| Переместить сообщение события (POST) | Почта.Написать | То же действие, что и для Message. |
| Копировать сообщение события (POST) | Почта.Написать | То же действие, что и для Message. |
| Создать черновик ответного сообщения (POST) | Mail.Write | То же действие, что и для Message. |
| Создать черновик ответного сообщения для всех (POST) | Mail.Write | То же действие, что и для Message. |
| Создать ответ (POST) | Mail.Write | То же действие, что и для Message. |
| Создать ответ всем (POST) | Mail.Write | То же действие, что и для Message. |
| Отправить существующее сообщение события (POST) | Mail.Write | Вы можете отправлять сообщение события, только когда свойство IsDraft имеет значение true. Копия сообщения сохраняется в папке «Отправленные». |
| Создать черновик сообщения переадресации события | Mail.Write | То же действие, что и для Message. |
| Переадресовать сообщение события | Mail.Write | То же действие, что и для Message. |
Экземпляр EventMessage включает свойства Message базового типа, а также свойства, перечисленные в следующей таблице.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| Событие | Событие | Событие, связанное с сообщением о событии. Предположение для посетителей или ресурсов комнаты заключается в том, что для помощника по ведению календаря установлено автоматическое обновление календаря событием при поступлении сообщений на событие запроса собрания. Свойство навигации. | Нет | Нет |
| MeetingMessageType | MeetingMessageType | Тип сообщения события: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5 | Нет | Да |
EventMessageRequest (preview)
Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел Office 365 REST API reference и выберите beta.
Расширенные свойства
Эта функция в настоящий момент доступна в бета-версии и версии 2.0. Чтобы узнать больше, в оглавлении слева, перейдите в раздел Office 365 REST API reference и выберите нужную вам версию.
FileAttachment
Файл (такой как текстовый файл или документ Word), прикрепленный к сообщению или событию. Свойство ContentBytes включает содержимое файла в кодировке base64. Производится из объекта Attachment.
Тип: Microsoft.OutlookServices.FileAttachment
Базовый тип: Microsoft.OutlookServices.Attachment
| Свойство | Тип | Описание | Записываемый? |
|---|---|---|---|
| Байты Контента | двоичный | Двоичный контент файла. | Нет |
| Идентификатор контента | Строка | Идентификатор вложения в хранилище Exchange. | Нет |
| ContentLocation | Строка | Унифицированный идентификатор ресурса (URI), который соответствует расположению содержимого вложения. | Нет |
| Тип контента | Строка | Тип контента этого вложения. | Да |
| DateTimeLastModified | datetimeoffset | Дата и время последнего изменения вложения. | Нет |
| Id | Строка | Идентификатор вложения. | Нет |
| IsContactPhoto | логический | Устаревший. | Да |
| Встроеное | логический | Задайте "верно", если это встроенное вложение. | Да |
| Имя | Строка | Имя, представляющее текст, который отображается под значком, представляющим внедренное вложение. Оно может не быть фактическим именем файла. | Да |
| Размер | Int32 | Размер вложения в байтах. | Нет |
Folder / MailFolder
Примечание
В версиях после версии 1.0, объект и тип ** Folder** были переименованы в ** MailFolder**.
Папка в почтовом ящике пользователя, например «Входящие», «Черновики» и «Отправленные». Папки могут содержать сообщения и другие папки.
Тип: Microsoft.OutlookServices.Folder
Коллекция Папки возвращает массив папок в значение свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/folders/$count
Информацию о поддерживаемых действиях см. в статье Folder operations.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| ChildFolderCount | Int32 | Количество папок в папке. | Нет | Да |
| Дочерние Папки | Коллекция(Folder) | Коллекция дочерних папок в папке. Свойство навигации. | Нет | Нет |
| Отображаемое имя | Строка | Отображаемое имя папки. | Да | Да |
| Id | Строка | Уникальный идентификатор папки. Вы можете использовать следующие известные имена для доступа к соответствующей папке: Входящие, Черновик, Отправленные, Удаленные. | Нет | Нет |
| Сообщения | Коллекция(Сообщение) | Коллекция сообщений в папке. Свойство навигации. | Нет | Нет |
| ParentFolderId | Строка | Уникальный идентификатор родительской папки для папки. | Нет | Нет |
| TotalItemCount | Int32 | Количество элементов в папке. | Нет | Да |
| Количество непрочитанных элементов | Int32 | Количество элементов в папке, помеченных как непрочитанные. | Нет | Да |
Эффективный доступ к сведениям о количестве элементов
Свойства папки Общее количество элементов и Количество непрочитанных элементов позволяют легко вычислить количество прочитанных элементов в папке. Они позволяют избежать подачи запросов, подобных тем, которые приводятся ниже, и которые могут вызывать значительную задержку:
https://outlook.office.com/api/v1.0/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false
Папки в Outlook могут содержать более одного типа элементов, например, папка «Входящие» может содержать элементы запроса на собрание, которые отличаются от почтовых элементов. Свойства Общее количество элементов и Количество непрочитанных элементов включают элементы в папке независимо от типа элементов.
Классификация логических выводов
Эта функция в настоящий момент доступна в версии 2.0 и бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел ссылка на Office 365 REST API и выберите одну из этих версий.
Переопределение классификации логических выводов
Эта функция в настоящий момент доступна в версии 2.0 и бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел ссылка на Office 365 REST API и выберите одну из этих версий.
Элемент Вложение
Сообщение, контакт или событие, прикрепленное к другому сообщению или событию. Производится из объекта Attachment.
Тип: Microsoft.СлужбыOutlook.Элемент Вложение
Базовый тип: Microsoft.OutlookServices.Attachment
| Свойство | Тип | Описание | Записываемый? |
|---|---|---|---|
| Тип контента | Строка | Тип контента этого вложения. | Да |
| Дата и время последнего изменения | коррекция даты, времени | Время и дата последнего изменения вложения. | Нет |
| Идентификатор | Строка | Идентификатор вложения. | Нет |
| Элемент | Элемент | Вложенное сообщение или событие. Свойство навигации. | Да |
| Встроеное | логическое значение | Укажите "верно", если вложение является встроенным, например встроенным изображением в теле элемента. | Да |
| Имя | Строка | Отображаемое имя вложения. | Да |
| Размер | Int32 | Размер вложения в байтах. | Да |
Упоминание (предварительный просмотр)
Эта функция в настоящий момент доступна только в бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел Office 365 REST API reference и выберите beta.
Сообщение
Сообщение в папке почтового ящика.
Тип: Microsoft.OutlookServices.Message
Коллекция Сообщение возвращает массив сообщений в значение свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/messages/$count
Информацию о поддерживаемых действиях см. в статье Операции с Сообщением.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? | Доступно для поиска? |
|---|---|---|---|---|---|
| Вложения | Коллекция (Вложение) | Вложения FileAttachment и ItemAttachment сообщения. Свойство навигации. | Да | Нет | Да |
| Получатели Скрытой копии | Коллекция (Recipient) | Получатели скрытой копии сообщения. | Да | Нет | Да |
| Текст | ItemBody | Текст сообщения. | Да | Нет | По умолчанию |
| BodyPreview | Строка | Первые 255 символов в контенте текста сообщения. | Нет | Нет | Да |
| Категории | Коллекция (Строка) | Категории, связанные с сообщением. | Да | Да | Да |
| Получатели копий | Коллекция (Получатель) | Получатели копии сообщения. | Да | Нет | Да |
| Клавиша изменения | Строка | Версия сообщения. | Нет | Нет | Нет |
| Идентификатор беседы | Строка | Идентификатор беседы, к которой принадлежит электронное сообщение. | Нет | Да | Нет |
| DateTimeCreated | коррекция даты, времени | Дата и время создания сообщения. | Нет | Да | Нет |
| Дата и время последнего изменения | коррекция даты, времени | Дата и время последнего изменения сообщения. | Нет | Да | Нет |
| Дата Время Получения | коррекция даты, времени | Дата и время получения сообщения. | Нет | Да | Да |
| Дата Время Отправки | коррекция даты, времени | Дата и время отправки сообщения. | Нет | Да | Нет |
| От | Получатель | Владелец почтового ящика и отправитель сообщения. | Да | Да | Да |
| HasAttachments | логическое значение | Указывает на наличие вложений в сообщении. | Да | Да | Да |
| Идентификатор | Строка | Уникальный идентификатор сообщения. | Нет | Нет | Нет |
| Важность | Важность | Важность сообщения: Низкая = 0, Нормальная = 1, Высокая = 2. | Да | Да | Да |
| Запрос отчета о доставке | логическое значение | Указывает, запрашивается ли уведомление о прочтении сообщения. | Да | Да | Нет |
| Черновик | логическое значение | Указывает, является ли сообщение черновиком. Сообщение считается черновиком, если оно еще не отправлено. | Нет | Да | Нет |
| Прочитанные | логическое значение | Указывает, прочитано ли сообщение. | Да | Да | Нет |
| Запрос отчета о прочтении | логическое значение | Указывает, запрашивается ли уведомление о прочтении сообщения. | Да | Да | Нет |
| ParentFolderId | Строка | Уникальный идентификатор родительской папки сообщения. | Нет | Нет | Нет |
| Ответить | Коллекция (Получатель) | Электронные адреса, которые необходимо использовать при ответе. | Да | Нет | Нет |
| Отправитель | Получатель | Учетная запись, которая фактически используется для создания сообщения. | Да | Да | По умолчанию |
| Тема | Строка | Тема сообщения. | Да | Да | По умолчанию |
| Получателям | Коллекция (Получатель) | Получателям сообщения. | Да | Нет | Да |
| Уникальный Текст | ItemBody | Текст сообщения, которое уникально для беседы. | Нет | Нет | Нет |
| WebLink | Строка | URL-адрес для открытия сообщения в Outlook Web App. Чтобы изменить способ отображения сообщения, можно добавить аргумент ispopout в конце URL-адреса. Если аргумент ispopout отсутствует или для него задано значение 1, то сообщение откроется во всплывающем окне. Если для аргумента ispopout задано значение 0, то в браузере сообщение будет отображаться в области просмотра Outlook Web App. Сообщение откроется в браузере, если вы вошли в свой почтовый ящик с помощью Outlook Web App. Если вход с помощью браузера еще не выполнен, вам будет предложено войти. Доступ к этому URL-адресу можно получить из iFrame. |
Нет | Да | Нет |
Удаление скрипта из свойства Текста
Текст сообщения может иметь формат HTML или текстовый. Если текст представлен в формате HTML, то по умолчанию, любой потенциально опасный HTML (например, JavaScript), встроенный в свойство BТекст будет удален до того, как содержимое будет возвращено в ответе REST.
Чтобы получить весь исходный HTML-контент, включите следующий заголовок HTTP-запроса:
Prefer: outlook.allow-unsafe-html
Настройка свойств От и Отправитель
В большинстве случаев при написании сообщения свойства From и Sender представляют одного вошедшего пользователя, если ни одно из них не было обновлено, как описано ниже.
Свойство From можно изменить, если администратор Exchange назначил права SendAs почтового ящика другим пользователям. Администратор может сделать это, выбрав Разрешения для почтового ящика владельца почтового ящика на портале управления Azure или с помощью центра администрирования Exchange или командлета Add-ADPermission Windows PowerShell. Затем вы можете программно установить свойство From одному из этих пользователей, которые обладают правами SendAs для этого почтового ящика.
Свойство Отправитель может быть изменено, если владелец почтового ящика делегировал одному или нескольким пользователям возможность отправлять сообщения с этого почтового ящика. Владелец почтового ящика может делегировать разрешения в Outlook. Когда делегат отправляет сообщение от имени владельца почтового ящика, свойство Отправитель принимает значение учетной записи делегата, а свойство От сохраняется за владельцем почтового ящика. Программно можно установить свойство Sender пользователю, который получил право делегата на этот почтовый ящик.
Правило Сообщения (предварительный просмотр)
Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел Office 365 REST API reference и выберите beta.
Категория Outlook (предварительный просмотр)
Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел Office 365 REST API reference и выберите beta.
Фото
Эта функция в настоящий момент доступна в версии 2.0 и бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел ссылка на Office 365 REST API и выберите одну из этих версий.
Вложение Ссылки
Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, в оглавлении слева, перейдите в раздел Office 365 REST API reference и выберите beta.
Задача
Эта функция в настоящий момент доступна в бета-версии и версии 2.0. Чтобы узнать больше, в оглавлении слева, перейдите в раздел ссылка на Office 365 REST API и выберите одну из этих версий.
Папка задач
Эта функция в настоящий момент доступна в бета-версии и версии 2.0. Чтобы узнать больше, в оглавлении слева, перейдите в раздел ссылка на Office 365 REST API и выберите одну из этих версий.
Группа Задания
Эта функция в настоящий момент доступна в бета-версии и версии 2.0. Чтобы узнать больше, в оглавлении слева, перейдите в раздел ссылка на Office 365 REST API и выберите одну из этих версий.
Пользователь
Пользователь в системе. Конечная точка Я предоставляется в качестве ярлыка для указания текущего пользователя по SMTP-адресу ( users/sadie@contoso.com).
Тип: Microsoft.Службы Outlook.Пользователь
Коллекция Users возвращает массив пользователей в значение свойства ответа OData. Для подсчета объектов в коллекции используйте $count: .../me/users/$count
Примечание
Объект Пользователь включает множество свойств и отношений (свойства навигации), которые часто обновляются. В следующем разделе описываются только подмножество. Для получения текущей информации см. определение Пользователь в соответствующем файле метаданных для вашей версии.
| Свойство | Тип | Описание | Записываемый? | Фильтрующийся? |
|---|---|---|---|---|
| Псевдоним | Строка | Псевдоним пользователя. Обычно это SMTP-адрес пользователя. | Да | Да |
| Календарь | Календарь | Основной календарь пользователя. Свойство навигации. | Нет | Нет |
| Группы Календаря | Коллекция(CalendarGroup) | Группы календарей пользователя. Свойство навигации. | Нет | Нет |
| Календари | Коллекция (Календарь) | Календари пользователей. Свойство навигации. | Нет | Нет |
| Вид календаря | Коллекция (Событие) | Представление календаря для календаря. Свойство навигации. | Нет | Нет |
| Папки Календаря | Коллекция (Папка Контакта) | Папки контактов пользователя. Свойство навигации. | Нет | Нет |
| Контакты | Коллекция (Contact) | Контакты пользователя. Свойство навигации. | Нет | Нет |
| Отображаемое имя | Строка | Отображаемое имя пользователя. | Да | Да |
| События | Коллекция (Событие) | События пользователя. Значение по умолчанию: показывать события в календаре по умолчанию. Свойство навигации. | Нет | Нет |
| Папки | Коллекция(Folder) | Папки в почтовом ящике или папке. Свойство навигации. | Нет | Нет |
| Идентификатор | Строка | Уникальный идентификатор для пользователя. | Нет | Нет |
| GUID Потового ящика | guid | GUID, назначенный почтовому ящику пользователя. | Нет | Да |
| Сообщения | Коллекция(Сообщение) | Сообщения в почтовом ящике или папке. Свойство навигации. | Нет | Нет |
| Корневая папка | Папка | Корневая папка почтового ящика пользователя. Свойство навигации. | Нет | Нет |
Сложные типы
- Участник
- Адрес электронной почты
- GeoCoordinates
- ItemBody
- Местоположение
- Шаблонная Повторяемость
- Физический адрес
- Получатель
- RecurrencePattern
- RecurrenceRange
- Статус Ответа
Участник
Участник события.
Тип: Microsoft.OutlookServices.Recipient
| Свойство | Тип | Описание |
|---|---|---|
| Состояние | ResponseStatus | Ответ (нет, принят, отклонен и т. д.) и время. |
| Тип | Тип Участника | Тип участника: Required, Optional, Resource. |
Адрес электронной почты
Имя и электронный адрес контакта или получателя сообщения.
Тип: Microsoft.OutlookServices.EmailAddress
| Свойство | Тип | Описание |
|---|---|---|
| Имя | Строка | Отображаемое имя человека или объекта. |
| Адрес | Строка | Электронный адрес человека или объекта. |
GeoCoordinates
Географические координаты и высота расположения.
Тип: Microsoft.OutlookServices.EmailAddress
| Свойство | Тип | Описание |
|---|---|---|
| Высота над уровнем моря | двойной | Высота над уровнем моря местоположения. |
| Широта | двойной | Широта местоположения. |
| Долгота | двойной | Долгота местоположения. |
| Точность | double | Точность датчика, предоставляющего данные о широте и долготе. |
| AltitudeAccuracy | double | Точность датчика, предоставляющего данные высоты над уровнем моря. |
ItemBody
Содержимое текста сообщения или события.
Тип: Microsoft.OutlookServices.ItemBody
| Свойство | Тип | Описание |
|---|---|---|
| Тип контента | BodyType | Тип контента: Текст = 0, HTML = 1. |
| Контент | Строка | Текстовый или HTML контент. |
Местоположение
Местоположение события.
Тип: Microsoft.OutlookServices.Location
| Свойство | Тип | Описание |
|---|---|---|
| DisplayName | Строка | Имя, связанное с расположением. |
| Адрес | PhysicalAddress | Физический адрес расположения. |
| Координаты | GeoCoordinates | Географические координаты и высота расположения. |
Шаблонная Повторяемость
Расписание и диапазон повторения.
Тип: Microsoft.OutlookServices.PatternedRecurrence
| Свойство | Тип | Описание |
|---|---|---|
| Схема | RecurrencePattern | Частота события. |
| Диапазон | RecurrenceRange | Продолжительность события. |
Физический адрес
Физический адрес контакта.
Тип: Microsoft.OutlookServices.PhysicalAddress
| Свойство | Тип | Описание |
|---|---|---|
| Улица | Строка | Улица. |
| Город | Строка | Город. |
| Штат | Строка | Штат. |
| CountryOrRegion | Строка | Страна или регион. Это строковое значение в свободном формате, например "США". |
| Почтовый индекс | Строка | Почтовый индекс. |
Получатель
Представляет сведения о конечном пользователе, который отправляет или получает событие или сообщение.
Тип: Microsoft.OutlookServices.Recipient
| Свойство | Тип | Описание |
|---|---|---|
| Адрес электронной почты | Адрес электронной почты | Адрес электронной почты получателя. |
RecurrencePattern
Частота события.
Тип: Microsoft.OutlookServices.RecurrencePattern
| Свойство | Тип | Описание |
|---|---|---|
| Тип | Тип Схемы Повторения | Тип расписания повторения: Daily = 0, Weekly = 1, AbsoluteMonthly = 2, RelativeMonthly = 3, AbsoluteYearly = 4, RelativeYearly = 5. Правила шаблонов: - AbsoluteYearly. Необходимо задать параметры Month и DayOfMonth периодичности - RelativeYearly. Необходимо задать параметры Month, DaysOfWeek, а также индекс FirstDayOfWeek - AbsoluteMonthly. Необходимо задать параметр DayOfMonth - RelativeMonthly. Необходимо задать индекс FirstDayOfWeek и RecurrenceRange.NumberOfOccurrences - Weekly. Необходимо задать параметр DaysOfWeek и индекс FirstDayOfWeek - Daily. Никакой дополнительной информации о шаблоне не требуется. |
| Interval | Int32 | Количество единиц заданного типа повторений между происшествиями. |
| День месяца | Int32 | День месяца, в который возникает элемент. |
| Month | Int32 | Месяц, в котором возникает элемент. Это число от 1 до 12. |
| День недели | Коллекция(DayOfWeek) | Коллекция дней недели: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6. |
| FirstDayOfWeek | DayOfWeek | Дни недели: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6. |
| Указатель | WeekIndex | Индекс недели: первая = 0, вторая = 1, третья = 2, четвертая = 3, последняя = 4. |
RecurrenceRange
Продолжительность события.
Тип: Microsoft.OutlookServices.RecurrenceRange
| Свойство | Тип | Описание |
|---|---|---|
| Тип | RecurrenceRangeType | Диапазон повторения: EndDate = 0, NoEnd = 1, Numbered = 2. |
| StartDate | datetimeoffset | Обязательное: дата начала последовательности. |
| EndDate | datetimeoffset | Требуется для привязанных к датам шаблонов: дата окончания последовательности. Должно быть после даты начала. |
| NumberOfOccurrences | Int32 | Требуется для нумерованных шаблонов: количество повторений события. |
ResponseStatus
Состояние ответа к приглашению на собрание.
Тип: Microsoft.OutlookServices.ResponseStatus
| Свойство | Тип | Описание |
|---|---|---|
| Ответ | ResponseType | Тип ответа: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded. |
| Время | datetimeoffset | Дата и время возвращения ответа. |
Перечисления
DayOfWeek
Множество дней недели.
Поддерживаемые значения:
- Воскресенье
- Понедельник
- Вторник
- Среда
- Четверг
- Пятница
- Суббота
FreeBusyStatus
Указывает состояние доступности участника для собрания.
Поддерживаемые значения:
- Занят
- Свободен
- Не удобно
- Под вопросом
- Неизвестно
- WorkingElsewhere
ReferenceAttachmentPermissions
Разрешения доступа к файлу или папке вложенной ссылки.
Поддерживаемые значения:
- Другие
- Отображение
- Изменить
- AnonymousView
- AnonymousEdit
- OrganizationView
- OrganizationEdit
ReferenceAttachmentProviders
Возможные поставщики хранилищ файлов для вложенных ссылок.
Поддерживаемые значения:
- Dropbox
- OneDriveBusiness
- OneDriveConsumer
- Другие
Чувствительность
Указывает уровень конфиденциальности.
Поддерживаемые значения:
- Обычная задача
- Персональные
- Личные
- Конфиденциально
Параметры запросов OData
Вы можете использовать стандартные параметры запроса OData v4.0 для фильтрации запросов данных и сортировки, и отображения результатов страницы при работе с API «Почта», «Календарь» и «Контакты». При указании параметров запроса убедитесь, что символы, которые reserved for special meanings in an URI, закодированы надлежащим образом.
$searchдляsearch конкретных критериев$filterдля filter на конкретные критерии$selectдляrequest конкретных критериев$orderbyдля sort результатов$topи$skipк результатам page$expandдля расширения вложений сообщения и вложений события$countдля полученияcount объектов в коллекции. Этот параметр указан в URL-адресе:.../me/calendars/$count
При выполнение запросов с помощью API Почты, Календаря и Контактов всегда используется неглубокая область видимости. Возвращаются только элементы в текущей папке. Глубокие поисковые запросы не поддерживаются.
Поисковые запросы
Вы можете использовать параметр $search, чтобы ограничить результаты запроса сообщениями, соответствующими поисковому выражению. Строки поиска указываются с использованием расширенного синтаксиса запросов (AQS). Результаты сортируются по дате и времени отправки сообщения.
Примечание
Можно получить более 250 результатов из $search запроса. Можно использовать $search только с сообщениями. Поиск контактов и событий календаря не поддерживается.
Нельзя использовать $filter или $orderby в поисковом запросе. В противном случае получите сообщение об ошибке, подобное следующему.
{
"error":
{
"code":"ErrorInvalidUrlQuery",
"message":"The query parameter 'OrderBy' is invalid."
}
}
| Свойство | Описание |
|---|---|
| Вложение | Поиск указанного вложения по названию. |
| Скрытая копия | Поиск поля Bcc. |
| Текст или Контент | Поиск поля Body. Поддерживается только c поисковыми запросами по умолчанию. |
| Категория | Поиск поля Category. |
| Cc | Поиск Cc field. |
| From | Поиск поля From. |
| Has | Поиск поля HasAttachments. |
| Participants | Поиск полей To, Cc и Bcc. |
| Received | Поиск поля Received для конкретной даты, указанной в виде ММ/ДД/ГГГГ. |
| Sender | Поиск поля Sender. |
| Subject | Поиск поля Subject. |
| To | Поиск поля To. |
Поиск общих полей выполняется с помощью параметра запроса $search без указания свойства. При поиске по умолчанию ищутся свойства Body, Sender и Subject. Следующий поиск возвращает все сообщения в папке «Входящие», которые содержат слово «pizza» в любом из трех свойств по умолчанию.
Давайте посмотрим на некоторые примеры. Для простоты URL-адреса в примерах не были закодированы в URL; однако если вы попробуете использовать эти примеры, обязательно используйте кодировку URL перед отправкой их на сервер.
Для получения всех сообщений в папке «Входящие», содержащих слово «Pizza» в свойстве From, Subject или Body, можно использовать этот запрос.
GET https://outlook.office.com/api/v1.0/me/messages?$search="pizza"
Чтобы получить все сообщения в папке «Входящие», содержащие слово «Pizza» в свойстве Subject, можно использовать этот запрос.
GET https://outlook.office.com/api/v1.0/me/messages?$search="subject:pizza"
Чтобы получить все сообщения в папке «Входящие», которые были отправлены от определенного человека, можно использовать этот запрос.
GET https://outlook.office.com/api/v1.0/me/messages?$search="from:help@contoso.com"
В приведенных выше примерах не было кодировки URL. Вот те же примеры с кодировкой URL, готовые для отправки на ваш сервер.
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22from:help@contoso.com%22
Запросы фильтрации
Вы можете использовать параметр запроса $filter для указания условий поиска, используя следующие операторы фильтра.
Не все свойства поддерживают фильтрацию. Можно использовать только те свойства ресурса, которые отмечены "да" в "Фильтруемые?" «Подлежит фильтрации?» их соответствующей таблицы указано «Да». Если свойство не подлежит фильтрации, в ответе будет возвращено сообщение об ошибке, например, как показано ниже. Оно возвращается, если попытаться отфильтровать по свойству ChangeKey.
{
"error":
{
"code":"ErrorInvalidProperty",
"message":"The property 'ChangeKey' does not support filtering."
}
}
Если вы используете метод фильтрации, который не поддерживается, вы получите сообщение об ошибке, подобное тому, которое возвращается, когда метод фильтра startswith используется в свойстве ** Subject**:
{
"error":
{
"code":"ErrorInvalidUrlQueryFilter",
"message":"'contains' and 'startswith' are not supported for filtering. Use Search instead."
}
}
| Оператор | Тип | Пример |
|---|---|---|
| и | Логическое «и» (используется для объединения множественных критериев) | TotalCount gt 0 and ChildFolderCount eq 0 |
| или | Логическое «или«» (используется для объединения множественных критериев) | TotalCount gt 0 or ChildFolderCount eq 0 |
| равно | Равно | IsRead eq false |
| не равно | Не равно | Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High' |
| больше | Больше, чем | DateTimeReceived gt 2014-09-01T00:00:00Z |
| больше | Больше или равно | DateTimeLastModified ge 2014-09-01T00:00:00Z |
| Меньше | Меньше, чем | DateTimeReceived lt 2014-09-01T00:00:00Z |
| Меньше или равно | Меньше или равно | DateTimeLastModified le 2014-09-01T00:00:00Z |
Используйте одинарные кавычки ('), чтобы разграничить любое значение типа Строка в критерии фильтра. Используйте %27 для URL-кодирования одинарных кавычек. Сама строка не чувствительна к регистру.
Давайте посмотрим на некоторые примеры. Для простоты чтения, URL-адреса в примерах не были закодированы в URL; однако, если вы попробуете использовать эти примеры, обязательно используйте кодировку URL перед отправкой их на сервер.
Чтобы получить все события в календаре пользователя с определенной темой, можно фильтровать по свойству Subject.
GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject eq 'Mega Charity Bash'
Чтобы получить все непрочитанные сообщения в папке «Входящие», можно фильтровать по свойству IsRead.
GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead eq false
Чтобы получить все сообщения в папке «Входящие» с вложениями, можно фильтровать по свойству HasAttachments.
GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments eq true
Чтобы получить все сообщения в папке «Входящие», полученные с 1 сентября 2014 года, можно фильтровать по свойству DateTimeReceived.
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived ge 2014-09-01
Чтобы получить все сообщения в папке «Входящие», отправленные с адреса "hr@contoso.com", можно фильтровать по свойству Sender.
GET https://outlook.office.com/api/v1.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'
В приведенных выше примерах не было кодировки URL, здесь те же примеры с кодировкой URL и готовые для отправки на ваш сервер:
GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived%20ge%202014-09-01
GET https://outlook.office.com/api/v1.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27
Выберите определенные свойства, которые необходимо возвратить
Чтобы указать только свойства, необходимые вашему приложению, можно использовать параметр запроса $select.
Примечание
При получении элементов почты, календаря и контактов, всегда используйте параметр $select, чтобы исключить ненужные свойства среди полезных данных ответа с целью поддержания надлежащей производительности приложения. Если не включить параметр $select, будут возвращены все свойства элементов.
В следующем примере выполняется получение свойств Subject, Sender и DateTimeReceived для всех сообщений в папке «Входящие».
GET https://outlook.office.com/api/v1.0/me/messages?$select=Subject,Sender,DateTimeReceived
Сортировка результатов
Результаты можно сортировать с помощью параметра запроса $orderby. Задайте в качестве значения этого параметра имя свойства и дополнительно укажите возрастающий (по умолчанию) или убывающий порядок. Помните, что нельзя использовать $orderby параметр запроса с $search.
В следующем примере без кодировки URL происходит получение всех сообщений в папке «Входящие», отсортированных по свойству DateTimeReceived в порядке убывания.
GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived desc
Тот же пример с кодировкой URL:
GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived%20desc
Результаты страницы
По умолчанию запрос GET в отношении свойства Messages или ChildFolders, коллекции, или CalendarView возвращает десять записей (максимум 50). Вы можете изменить это поведение, используя параметр запроса $top, чтобы установить максимальное число. Следующий пример получает первые пять сообщений в папке «Входящие».
GET https://outlook.office.com/api/v1.0/me/messages?$top=5
Если в папке «Входящие» находится более пяти сообщений, ответ включает свойство odata.nextLink. Наличие этого свойства указывает на то, что на сервере доступны дополнительные элементы. Значение этого свойства представляет собой URI, который можно использовать для получения следующих пяти элементов.
GET https://outlook.office.com/api/v1.0/me/messages?$top=5&$skip=5
Постраничное отображение достигается путем использования параметра $top для указания размера страницы и параметра $skip как кратное размеру страницы. Увеличивая значение параметра $skip на величину размера страницы, можно запрашивать следующую страницу в наборе результатов.
Подсчет количества объектов в коллекции
Количество объектов в коллекции можно получить путем использования параметра $count. Запрос количества можно также фильтровать.
В этом примере отображается количество сообщений в папке «Входящие».
GET https://outlook.office.com/api/v1.0/me/messages/$count
А в этом примере без кодировки URL возвращается количество непрочитанных сообщений в папке «Входящие».
GET https://outlook.office.com/api/v1.0/me/messages/$count?$filter=IsRead eq false
Тот же пример с кодировкой URL.
GET https://outlook.office.com/api/v1.0/me/messages/$count?$filter=IsRead%20eq%20false
Подведение итогов
Вы можете комбинировать параметры для создания сложных запросов. В примере ниже создается более точный запрос сообщений в папке «Входящие» следующими способами.
Возврат только элементов, для которых свойство Importance имеет значение "Высокая".
Возврат только свойств Subject, Sender и DateTimeReceived.
Возврат только первых пяти сообщений.
Примечание
Для простоты чтения примера не используется кодировка URL, а также добавлены разрывы строк.
https://outlook.office.com/api/v1.0/me/messages?
$filter=Importance eq 'High'
&$select=Subject,Sender,DateTimeReceived
&$top=5
Когда вы указываете $filter, сервер определит порядок сортировки результатов. Если вы используете оба $filter и $orderby, свойства в $filter сначала должно быть указаны в $orderby перед другими свойствами и они должны быть перечислены в том порядке, в котором они представлены в $filter параметре. В следующем параметре показан запрос, отфильтрованный по свойствам Subject и Importance, а затем отсортированный по свойствам Subject, Importance и Sender.
https://outlook.office.com/api/v1.0/me/messages?
$filter=Subject eq 'Good Times' AND Importance eq 'High'&
$orderby=Subject,Importance,Sender
Вот те же примеры с кодировкой URL и без разрывов строк.
https://outlook.office.com/api/v1.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,DateTimeReceived&$top=5
https://outlook.office.com/api/v1.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender
Смотрите также
- API REST Outlook для центра разработок Outlook
- Обзор разработки на платформе Office 365
- Проверка подлинности приложений и авторизация ресурсов в Office 365
- Зарегистрируйте свое приложение вручную в Azure AD, чтобы предоставить приложению доступ к API Office 365
- Ссылка REST API Почты Outlook
- Справочник по API REST «Календарь» Outlook
- Ссылка REST API «Контакты» Outlook
- Ссылка REST API Задания Outlook