Поделиться через

Ссылка на ресурсы для REST API почты, календаря, контактов и задач (версия 2.0)

  • Статья

Область применения: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

В этой статье описываются объекты, свойства, сложные типы и перечисления REST API, а также параметры запросов OData, которые можно использовать с API почты, календаря, контактов и задач в Outlook, чтобы получить доступ к данным почтового ящика пользователя в Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com и Passport.com.

Примечание

Для упрощения справочной информации, в оставшейся части этой статьи при упоминании Outlook.com также подразумеваются и эти домены учетной записи Майкрософт.

См.Использование REST API Outlook, чтобы больше узнать обо всех подмножествах Outlook REST API.

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

Совет

Просмотреть полный документ метаданных для модели данных объекта почта, календарь, контакты и задача можно при переходе к конечной точке в $metadata в веб-обозревателе (пример: https://outlook.office.com/api/v2.0/$metadata).

Вложение

Файл или элемент (контакт, событие или сообщение), прикрепленный к событию, сообщению или задаче. Соответствующие ресурсы fileAttachment, itemAttachment и referenceAttachment являются производными ресурса Attachment.

Тип: Microsoft.OutlookServices.Entity

Свойство Type Описание Подлежит записи? Фильтруемое?
ContentType Строка Тип MIME вложения. Да Нет
IsInline Логическое true если вложение является встроенным; в противном случае, false. Да Да
LastModifiedDateTime DateTimeOffset Дата и время последнего изменения вложения. Для даты и времени используется формат ISO 8601, и они всегда представляют собой время UTC.

Так, к примеру, полночь 1 января 2014 г. в формате UTC будет выглядеть следующим образом: «2014-01-01T00:00:00Z»		 Нет Да
Name Строка Отображаемое имя вложения. Его совпадение с фактическим именем файла не обязательно. Да Да
Size Int32 Размер вложения в байтах. Нет Нет

Calendar

Календарь, представляюий ссобой контейнер для событий.

Тип: Microsoft.OutlookServices.Calendar

Коллекция Календарь возвращает массив календарей в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/calendars/$count

Информацию о поддерживаемых действиях см. в статье Операции календаря.

Свойство Type Описание Подлежит записи? Фильтруемое?
CanEdit Логическое Значение true, если пользователь может вносить изменения в календарь, в противном случае — значение false. Это свойство имеет значение true для пользователя, создавшего календарь. Это свойство также имеет значение true для пользователей, которые совместно используют календарь и имеют доступ на запись. Нет Да
CanShare Логическое Значение true, если у пользователя есть разрешение на совместное использование календаря, в противном случае — значение false. Только пользователь, создавший календарь, может предоставлять общий доступ к нему. Нет Да
CanViewPrivateItems Логическое Значение true, если пользователь может читать элементы календаря, которые были помечены как частные, в противном случае — значение false. Нет Да
ChangeKey Строка Идентифицирует версию объекта календаря. При каждом изменении календаря свойство ChangeKey также меняется. Это позволяет Exchange применять изменения к правильной версии объекта. Нет Нет
Color CalendarColor Задает цветовую тему, отличающую этот календарь от других календарей в пользовательском интерфейсе. Значения свойств: LightBlue = 0, LightGreen = 1, LightOrange = 2, LightGray = 3, LightYellow = 4, LightTeal = 5, LightPink = 6, LightBrown = 7, LightRed = 8, MaxColor = 9, Auto = -1. Да Да
Id Строка Уникальный идентификатор календаря. Нет Нет
Name Строка Имя календаря. Да Да
Owner EmailAddress Если задано, это свойство представляет пользователя, создавшего или добавившего календарь. Для календаря, который пользователь создал или добавил, свойство Владелец свойство задано пользователю. Для календаря, совместно используемого с другим пользователем, свойство Owner присваивается тому, кто предоставил этому пользователю общий доступ к календарю. Нет Да
CalendarView Коллекция (Event) Представление календаря для календаря. Свойство навигации. Нет Нет
Events Коллекция (Event) События в календаре. Свойство навигации. Нет Нет
MultiValueExtendedProperties Коллекция Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да
SingleValueExtendedProperties Коллекция Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да

CalendarGroup

Группа календарей.

Примечание

Outlook.com поддерживает только группу календарей по умолчанию, доступ к которой осуществляется с помощью ярлыка ../me/calendars. Удалить эту группу календарей невозможно.

Тип: Microsoft.OutlookServices.CalendarGroup

Коллекция CalendarGroup возвращает массив групп календарей в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/calendargroups/$count

См. Операции CalendarGroup для получения информации о поддерживаемых действий.

Свойство Type Описание Подлежит записи? Фильтруемое?
Name Строка Имя группы. Да Да
ChangeKey Строка Идентифицирует версию группы календарей. При каждом изменении группы календарей свойство ChangeKey также меняется. Это позволяет Exchange применять изменения к правильной версии объекта. Нет Нет
ClassId Строка Идентификатор класса. Нет Да
Id Строка Уникальный идентификатор группы календарей. Нет Нет
Calendars Коллекция (Calendar) Календари в группе календарей. Свойство навигации. Нет Нет

Контакт

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

Тип: Microsoft.OutlookServices.Contact

Коллекция Contact возвращает массив контактов в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/contacts/$count

Информацию о поддерживаемых действиях см. в статье Операции с контактами.

Свойство Type Описание Подлежит записи? Фильтруемое?
AssistantName Строка Имя помощника контакта. Да Да
Birthday datetimeoffset Дата рождения контакта. Да Да
BusinessAddress PhysicalAddress Рабочий адрес контакта. Да Да
BusinessHomePage Строка Рабочая домашняя страница контакта. Да Да
BusinessPhones Коллекция (Строка) Номера рабочих телефонов контакта. Да Нет
Categories Коллекция (Строка) Категории, связанные с контактом. Да Нет
ChangeKey Строка Идентифицирует версию контакта. При каждом изменении контакта свойство ChangeKey также меняется. Это позволяет Exchange применять изменения к правильной версии объекта. Нет Нет
Children Коллекция (Строка) Имена детей контакта. Да Да
CompanyName Строка Название компании контакта. Да Да
Department Строка Отдел контакта. Да Да
CreatedDateTime datetimeoffset Время создания контакта. Нет Да
LastModifiedDateTime datetimeoffset Время изменения контакта. Нет Да
DisplayName Строка Отображаемое имя контакта. Да Да
EmailAddresses Коллекция (EmailAddress) Адреса электронной почты контакта. Да Нет
Extensions Коллекция (Extension) Коллекция модулей обработки данных открытого типа, определенных для контакта. Свойство навигации. Нет Да
FileAs Строка Имя, под которым хранится контакт. Да Да
Generation Строка Поколение контакта. Да Да
GivenName Строка Имя контакта. Да Да
HomeAddress PhysicalAddress Домашний адрес контакта. Да Да
HomePhones Коллекция (Строка) Номера домашних телефонов контакта. Да Нет
Id Строка Уникальный идентификатор контакта. Нет Нет
ImAddresses Коллекция (Строка) Адреса контакта для обмена мгновенными сообщениями. Да Нет
Initials Строка Инициалы контакта. Да Да
JobTitle Строка Должность контакта. Да Да
Руководитель Строка Имя руководителя контакта. Да Да
MiddleName Строка Отчество контакта. Да Да
MobilePhone1 Строка Номер мобильного телефона контакта. Да Да
NickName Строка Псевдоним контакта. Да Да
OfficeLocation Строка Расположение офиса контакта. Да Да
OtherAddress PhysicalAddress Другие адреса контакта. Да Да
ParentFolderId Строка Идентификатор родительской папки контакта. Нет Нет
PersonalNotes Строка Заметки пользователя о контакте. Да Да
Profession Строка Профессия контакта. Да Да
SpouseName Строка Имя супруга или супруги контакта. Да Да
Surname Строка Фамилия контакта. Да Да
Title Строка Должность контакта. Да Нет
YomiCompanyName Строка Название компании контакта, записанное так, как оно звучит по-японски. Да Нет
YomiGivenName Строка Имя контакта, записанное так, как оно звучит по-японски. Да Нет
YomiSurname Строка Фамилия контакта, записанная так, как она звучит по-японски. Да Нет

Свойства навигации MultiValueExtendedProperties и SingleValueExtendedProperties также доступны для данного ресурса и используются для представления коллекций соответствующих типов расширенных свойств, определенных для экземпляра ресурса. Для получения дополнительной информации см. Расширенные свойства REST API.

ContactFolder

Папка, содержащая контакты.

Тип: Microsoft.OutlookServices.ContactFolder

Коллекция ContactFolder возвращает массив папок контактов в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/contactfolders/$count

См. информацию о поддерживаемых действиях в статье Операции с ContactFolder.

Свойство Type Описание Подлежит записи? Фильтруемое?
ChildFolders Collection(ContactFolder) Коллекция дочерних папок в папке. Свойство навигации. Нет Нет
Contacts Коллекция (Contact) Контакты в папке. Свойство навигации. Нет Нет
DisplayName Строка Отображаемое имя папки. Да Да
Id Строка Уникальный идентификатор папки с контактами. Нет Нет
ParentFolderId Строка Идентификатор папки, являющейся родительской для этой папки. Нет Нет
MultiValueExtendedProperties Коллекция Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да
SingleValueExtendedProperties Коллекция Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да

Event

Событие в календаре.

Тип: Microsoft.OutlookServices.Event

Коллекция Event возвращает массив событий в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/events/$count

Информацию о поддерживаемых действиях см. в статье Операции с событиями.

Свойство Type Описание Подлежит записи? Фильтруемое?
Attachments Коллекция (Attachment) Коллекция вложений FileAttachment, ItemAttachment и ReferenceAttachment для события. Свойство навигации. Нет Нет
Attendees Коллекция (Attendee) Коллекция участников события. Да Нет
Body ItemBody Текст сообщения, связанного с событием. Да Нет
BodyPreview Строка Предварительный просмотр сообщения, связанного с событием. Нет Нет
Calendar Calendar Календарь, содержащий событие. Свойство навигации. Нет Нет
Categories Коллекция (Строка) Категории, связанные с событием. Да Нет
ChangeKey Строка Указывает версию объекта события. При каждом изменении события также меняется значение ChangeKey. Благодаря этому Exchange может применять изменения к правильной версии объекта. Нет Нет
CreatedDateTime datetimeoffset Дата и время создания события. Нет Да
LastModifiedDateTime datetimeoffset Дата и время последнего изменения события. Нет Да
End DateTimeTimeZone Время окончания события. Да Да
Extensions Коллекция (Extension) Коллекция модулей обработки данных открытого типа, определенных для события. Свойство навигации. Нет Да
HasAttachments Логическое Задайте значение true, если событие содержит вложения. Нет Да
Id Строка Уникальный идентификатор события. Нет Нет
Importance Importance Важность события: Low, Normal, High. Да Да
Instances Коллекция (Event) Экземпляры события. Свойство навигации. Нет Нет
iCalUID Строка Уникальный идентификатор, совместно используемый всеми экземплярами события в разных календарях. Нет Да
IsAllDay Логическое Задайте значение true, если событие продолжается в течение всего дня. Для настройки этого свойства необходимо также настроить свойства Start и End события. Да Да
IsCancelled Логическое Задайте значение true, если событие отменено. Да Да
IsOrganizer Логическое Задайте значение true, если отправитель сообщения также является его организатором. Да Да
IsReminderOn Логическое Задайте значение true, если для напоминания пользователю о событии установлено оповещение. Да Да
Location Location Место проведения события. Да Да
OnlineMeetingUrl Строка URL-адрес для проведения собрания по сети. Да Нет
Organizer Recipient Организатор события. Да Да
OriginalEndTimeZone Строка Часовой пояс, для которого при создании события указано время завершения события. Для получения списка допустимых часовых поясов см. DateTimeTimeZone. Нет Да
OriginalStartTimeZone Строка Часовой пояс, для которого при создании события указано время начала события. Для получения списка допустимых часовых поясов см. DateTimeTimeZone. Нет Да
Recurrence PatternedRecurrence Расписание повторения события. Да Нет
ReminderMinutesBeforeStart Int32 Позволяет указать, за сколько минут до начала события появляется напоминание. Да Нет
ResponseRequested Логическое Задайте значение true, если отправитель желает получить сообщение о согласии участвовать в событии или отклонении соответствующего приглашения. Да Да
ResponseStatus ResponseStatus Указывает тип ответа, передаваемого при получении сообщения о событии. Нет Да
Sensitivity Sensitivity Характеризует уровень конфиденциальности события: Нормальный = 0, Личный = 1, Частный = 2, Конфиденциальный = 3. Да Да
SeriesMasterId Строка Категории, назначенные элементу. Да Нет
ShowAs FreeBusyStatus Отображаемое состояние. Свободен = 0, Под вопросом = 1, Занят = 2, Нет на месте = 3, Работаю в другом месте = 4, Неизвестно = -1. Да Да
Начало DateTimeTimeZone Время начала события. Да Да
Type EventType Тип события: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3. Да Да
WebLink Строка URL-адрес для открытия события в Outlook Web App.

Событие откроется в браузере, если вы вошли в свой почтовый ящик с помощью Outlook Web App. Если вход с помощью браузера еще не выполнен, вам будет предложено войти.

Доступ к этому URL-адресу можно получить из объекта iFrame.		 Нет Нет

Свойства навигации MultiValueExtendedProperties и SingleValueExtendedProperties также доступны для данного ресурса и используются для представления коллекций соответствующих типов расширенных свойств, определенных для экземпляра ресурса. Для получения дополнительной информации см. Расширенные свойства REST API.

EventMessage

Сообщение, которое представляет собой приглашение на собрание, сообщение об отмене собрания, сообщение о принятии приглашения на собрание, сообщение о том, что посещение собрания остается под вопросом, или сообщение об отказе участвовать в собрании.

Базовый тип: Message

Экземпляр EventMessage обычно находится в папке «Входящие», где он появляется в результате создания собрания организатором события или в результате ответа участником на запрос о присоединении к собранию. Вы воздействуете на сообщения о событиях так же, как и на тип Message, с некоторыми незначительными отличиями, описанными в следующей таблице.

Действие/команда Permission Описание
Создать сообщение о событии (POST) Н/Д Запрещено. В результате отобразится код отклика 400.
Обновить сообщение события (PATCH) Mail.Write Вы можете обновить свойства From, Sender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Subject, Body, Importance и Categories.
Удалить сообщение события (DELETE) Mail.Write То же действие, что и для Message.
Переместить сообщение события (POST) Mail.Write То же действие, что и для Message.
Копировать сообщение события (POST) Mail.Write То же действие, что и для 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 и свойства, перечисленные в следующей таблице.

Свойство Type Описание Подлежит записи? Фильтруемое?
Event Event Событие, связанное с сообщением о событии. Предположение для посетителей или ресурсов комнаты заключается в том, что для помощника по ведению календаря установлено автоматическое обновление календаря событием при поступлении сообщений на событие запроса собрания. Свойство навигации. Нет Нет
MeetingMessageType MeetingMessageType Тип сообщения о событии: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5 Нет Да

EventMessageRequest (предварительная версия)

Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, перейдите к разделу Справочник по Office 365 REST API в оглавлении, слева, и выберите опцию бета-версия.

Расширенные свойства

Настраиваемое свойство для объекта можно создать в виде MultiValueLegacyExtendedProperty или SingleValueLegacyExtendedProperty, в зависимости от значений, предназначенных для этого свойства.

MultiValueLegacyExtendedProperty

Расширенное свойство, которое может содержать коллекцию, состоящую из нескольких значений.

Тип: Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

Свойство Type Описание Подлежит записи? Фильтруемое?
Value Коллекция (Строка) Коллекция значений свойств. Да Нет
PropertyId Строка Идентификатор свойства. Используется для идентификации свойства. Нет Нет

SingleValueLegacyExtendedProperty

Расширенное свойство, содержащее одно значение.

Тип: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

Свойство Type Описание Подлежит записи? Фильтруемое?
Value Строка Значение свойства. Да Нет
PropertyId Строка Идентификатор свойства. Используется для идентификации свойства. Нет Да

При создании расширенного свойства PropertyId можно задать различными способами. Для получения дополнительной информации см. Форматы PropertyId.

См. Справка по расширенным свойствам REST API, чтобы больше узнать о соответствующих операциях, которые можно использовать.

FileAttachment

Файл (например, текстовый файл или документ Word), прикрепленный к сообщению, событию или задаче. Свойство ContentBytes включает содержимое файла в кодировке base64. Производится из объекта Attachment.

Тип: Microsoft.OutlookServices.FileAttachment

Базовый тип: Microsoft.OutlookServices.Attachment

Свойство Type Описание Подлежит записи?
ContentBytes Двоичный Двоичное содержимое файла. Нет
ContentId Строка Идентификатор вложения в хранилище Exchange. Нет
ContentLocation Строка Универсальный код ресурса (URI), который соответствует расположению содержимого вложения. Нет
ContentType Строка Тип содержимого этого вложения. Да
LastModifiedDateTime datetimeoffset Дата и время последнего изменения вложения. Нет
Id Строка Идентификатор вложения. Нет
IsInline Логическое Значение true задается, если вложение является встроенным. Да
Name Строка Имя, представляющее текст, который отображается под значком, представляющим внедренное вложение. Оно может не быть фактическим именем файла. Да
Size Int32 Размер вложения в байтах. Нет

Folder / MailFolder

Примечание

В версии 2.0 объект и тип, ранее известные, как Folder, были переименованы в MailFolder.

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

Тип: Microsoft.OutlookServices.MailFolder

Коллекция MailFolders возвращает массив папок в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/folders/$count

Информацию о поддерживаемых действиях см. в статье Операции с папкой.

Свойство Type Описание Подлежит записи? Фильтруемое?
ChildFolderCount Int32 Количество папок, содержащихся в папке. Нет Да
ChildFolders Коллекция(MailFolder) Коллекция дочерних папок в папке. Свойство навигации. Нет Нет
DisplayName Строка Отображаемое имя папки. Да Да
Id Строка Уникальный идентификатор папки. Для доступа к соответствующим папками могут использоваться следующие распространенные имена: Входящие, Черновик, Отправленные, Удаленные. Нет Нет
Messages Коллекция (Message) Коллекция сообщений в папке. Свойство навигации. Нет Нет
ParentFolderId Строка Уникальный идентификатор папки, являющейся родительской для папки. Нет Нет
TotalItemCount Int32 Количество элементов в папке. Нет Да
UnreadItemCount Int32 Количество элементов в папке, помеченных как непрочитанные. Нет Да
MultiValueExtendedProperties Коллекция Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да
SingleValueExtendedProperties Коллекция Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да

Эффективный доступ к сведениям о количестве элементов

Свойства TotalItemCount и UnreadItemCount папки позволяют без труда определить количество прочитанных элементов в папке. Они позволяют избежать подачи запросов, подобных тем, которые приводятся ниже и могут вызывать значительную задержку:

https://outlook.office.com/api/v2.0/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Папки в Outlook могут содержать несколько типов элементов, например, папка «Входящие» может содержать элементы, представляющие собой приглашение на собрание, которые отличаются от элементов почты. Свойства TotalItemCount и UnreadItemCount включают в себя элементы, содержащиеся в папке, независимо от их типа.

InferenceClassification

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

Тип: Microsoft.OutlookServices.InferenceClassification

Свойство Type Описание Подлежит записи?
Overrides Коллекция (InferenceClassificationOverride) Набор переопределений для того, чтобы пользователь всегда классифицировал сообщения от определенных отправителей определенным образом в соответствии с возможностями типа InferenceClassificationType. Свойство навигации. Да

InferenceClassificationOverride

Характеризует пользовательское переопределение того, как должны классифицироваться входящие сообщения от определенного отправителя.

Тип: Microsoft.OutlookServices.InferenceClassificationOverride

Свойство Type Описание Подлежит записи?
ClassifyAs InferenceClassificationType Указывает, как должны классифицироваться все входящие сообщения от определенного отправителя. Важное = 0, Другое = 1. Да
Id Строка Уникальный идентификатор переопределения. Нет
SenderEmailAddress EmailAddress Адрес электронной почты отправителя, для которого создано переопределение. Да

ItemAttachment

Сообщение, контакт или событие, прикрепленное к другому сообщению, событию или задаче. Производится из объекта Attachment.

Тип: Microsoft.OutlookServices.ItemAttachment

Базовый тип: Microsoft.OutlookServices.Attachment

Свойство Type Описание Подлежит записи?
ContentType Строка Тип содержимого этого вложения. Да
LastModifiedDateTime datetimeoffset Время и дата последнего изменения вложения. Нет
Id Строка Идентификатор вложения. Нет
Item Item Вложенное сообщение или событие. Свойство навигации. Да
IsInline Логическое Значение true указывает, что вложение является встроенным, например внедренным изображением в теле элемента. Да
Name Строка Отображаемое имя вложения. Да
Size Int32 Размер вложения в байтах. Да

Mention (предварительная версия)

Эта функция в настоящий момент доступна только в бета-версии. Чтобы узнать больше, перейдите к разделу Справочник по Office 365 REST API в оглавлении, слева, и выберите опцию бета-версия.

Message

Сообщение в папке почтового ящика.

Тип: Microsoft.OutlookServices.Message

Коллекция Message возвращает массив сообщений в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/messages/$count

Информацию о поддерживаемых действиях см. в статье Операции с сообщениями.

Свойство Type Описание Подлежит записи? Фильтруемое? Доступно для поиска?
Attachments Коллекция (Attachment) Вложения FileAttachment и ItemAttachment сообщения. Свойство навигации. Да Нет Да
BccRecipients Коллекция (Recipient) Получатели скрытой копии сообщения. Да Нет Да
Body ItemBody Текст сообщения. Да Нет Default
BodyPreview Строка Первые 255 символов, входящих в состав текста сообщения. Нет Нет Да
Categories Коллекция (Строка) Категории, связанные с сообщением. Да Да Да
CcRecipients Коллекция (Recipient) Получатели копии сообщения. Да Нет Да
ChangeKey Строка Версия сообщения. Нет Нет Нет
ConversationId Строка Идентификатор беседы, к которой принадлежит электронное сообщение. Нет Да Нет
CreatedDateTime datetimeoffset Дата и время создания сообщения. Нет Да Нет
Extensions Коллекция (Extension) Коллекция модулей обработки данных открытого типа, определенных для сообщения. Свойство навигации. Нет Да Нет
From Recipient Владелец почтового ящика и отправитель сообщения. Да Да Да
HasAttachments Логическое Указывает на наличие вложений в сообщении. Нет Да Да
Id Строка Уникальный идентификатор сообщения. Нет Нет Нет
Importance Importance Важность сообщения: Низкая = 0, Нормальная = 1, Высокая = 2. Да Да Да
InferenceClassification InferenceClassificationType Классификация сообщения для пользователя, основанная на предполагаемой релевантности или важности, либо на явном переопределении. Да Да Да
IsDeliveryReceiptRequested Логическое Указывает, запрашивается ли уведомление о прочтении сообщения. Да Да Нет
IsDraft Логическое Указывает, является ли сообщение черновиком. Сообщение считается черновиком, если оно еще не отправлено. Нет Да Нет
IsRead Логическое Указывает, прочитано ли сообщение. Да Да Нет
IsReadReceiptRequested Логическое Указывает, запрашивается ли уведомление о прочтении сообщения. Да Да Нет
LastModifiedDateTime datetimeoffset Дата и время последнего изменения сообщения. Нет Да Нет
MultiValueExtendedProperties Коллекция Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да Нет
ParentFolderId Строка Уникальный идентификатор родительской папки сообщения. Нет Нет Нет
ReceivedDateTime datetimeoffset Дата и время получения сообщения. Нет Да Да
ReplyTo Коллекция (Recipient) Электронные адреса, которые необходимо использовать при ответе. Нет Нет Нет
Sender Recipient Учетная запись, которая фактически используется для создания сообщения. Да Да Default
SingleValueExtendedProperties Коллекция Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации.

См. дополнительную информацию о расширенных свойствах.		 Да Да Нет
SentDateTime datetimeoffset Дата и время отправки сообщения. Нет Да Нет
Subject Строка Тема сообщения. Да Да Default
ToRecipients Коллекция (Recipient) Получатели сообщения, указанные в поле Кому. Да Нет Да
UniqueBody ItemBody Текст сообщения, являющегося уникальным для данной беседы. Нет Нет Нет
WebLink Строка URL-адрес для открытия сообщения в Outlook Web App.

Чтобы изменить способ отображения сообщения, можно добавить аргумент ispopout в конце URL-адреса. Если аргумент ispopout отсутствует или для него задано значение 1, то сообщение откроется во всплывающем окне. Если для аргумента ispopout задано значение 0, то в браузере сообщение будет отображаться в области просмотра Outlook Web App.

Сообщение откроется в браузере, если вы вошли в свой почтовый ящик с помощью Outlook Web App. Если вход с помощью браузера еще не выполнен, вам будет предложено войти.

Доступ к этому URL-адресу можно получить из объекта iFrame.		 Нет Да Нет

Удаление сценария из свойства Body (Текст)

Текст сообщения может иметь формат HTML или текстовый. Если текст представлен в формате HTML, то по умолчанию любой потенциально опасный код HTML (например, JavaScript), встроенный в свойство Body удаляется из него до возврата текста в ответе REST.

Чтобы получить исходное содержимое HTML в полном объеме, необходимо указать следующий заголовок HTTP-запроса:

Prefer: outlook.allow-unsafe-html

Настройка свойств From (От) и Sender (Отправитель)

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

  • Свойство From можно изменить, если администратор Exchange назначил права SendAs почтового ящика другим пользователям. Администратор может сделать это, выбрав Разрешения для почтового ящика владельца почтового ящика на портале управления Azure или с помощью центра администрирования Exchange или командлета Add-ADPermission Windows PowerShell. Затем вы можете программно установить свойство From одному из этих пользователей, которые обладают правами SendAs для этого почтового ящика.

  • Свойство Sender можно изменить, если владелец почтового ящика делегировал одному или нескольким пользователям возможность отправлять сообщения с этого почтового ящика. Владелец почтового ящика может делегировать разрешения в Outlook. Когда делегат отправляет сообщение от имени владельца почтового ящика, свойство Sender принимает значение учетной записи делегата, а свойство From сохраняет значение, соответствующее владельцу почтового ящика. Программно можно установить свойство Sender пользователю, который получил право делегата на этот почтовый ящик.

MessageRule (предварительная версия)

Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, перейдите к разделу Справочник по Office 365 REST API в оглавлении, слева, и выберите опцию бета-версия.

OutlookCategory (предварительная версия)

Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, перейдите к разделу Справочник по Office 365 REST API в оглавлении, слева, и выберите опцию бета-версия.

Photo

Тип: Microsoft.OutlookServices.Photo

Фотография, доступная из Exchange Online. Это двоичные данные, не закодированные в формате base-64.

Свойство Type Описание Подлежит записи? Фильтруемое?
Height int Высота фотографии Нет Нет
Id Строка Уникальный идентификатор фотографии. Нет Нет
Width int Ширина фотографии. Нет Нет

ReferenceAttachment

Тип: Microsoft.OutlookServices.ReferenceAttachment

Базовый тип: Microsoft.OutlookServices.Attachment

Ссылка на файл или папку, прикрепленная к сообщению, событию или задаче. Возможные расположения файла или папки: OneDrive, OneDrive для бизнеса и DropBox. Производится из объекта Attachment.

Свойство Type Описание Подлежит записи? Фильтруемое?
ContentType Строка Тип MIME вложения. Необязательный. Да Нет
Id Строка Уникальный идентификатор вложенной ссылки. Нет Нет
IsFolder Логическое Указывает, является ли вложение ссылкой на папку. Если SourceUrl является ссылкой на папку, то необходимо установить значение true. Необязательный. Да Нет
IsInline Логическое true если вложение является встроенным; в противном случае, false. Необязательный. Да Да
LastModifiedDateTime DateTimeOffset Дата и время последнего изменения вложения. Для даты и времени используется формат ISO 8601, и они всегда представляют собой время UTC. Например, полночь 1 января 2014 г. по времени UTC будет выглядеть следующим образом: «2014-01-01T00:00:00Z». Необязательный. Нет Да
Name Строка Отображаемое имя вложения. Его совпадение с фактическим именем файла не обязательно. Обязательный. Да Да
Permission ReferenceAttachmentPermissions Характеризует разрешения, предоставленные для вложения по типу поставщика в ProviderType. Возможные значения: Other, View, Edit, AnonymousView, AnonymousEdit, OrganizationView, OrganizationEdit. Необязательный. Да Нет
PreviewUrl Строка Применяется только для вложенной ссылки на изображение, представляющей собой URL-адрес для предварительного просмотра изображения. Используйте свойства ThumbnailUrl и PreviewUrl, только когда SourceUrl указывает на файл изображения. Необязательный. Да Нет
ProviderType ReferenceAttachmentProviders Тип поставщика, который поддерживает вложение этого ContentType. Возможные значения: Other, OneDriveBusiness, OneDriveConsumer, Dropbox. Необязательный. Да Да
Size Int32 Размер вложения в байтах. Необязательный. Нет Нет
SourceUrl Строка URL для получения содержимого вложения. Если это URL-адрес на папку, то для надлежащего отображения папки в Outlook или Outlook в Интернете установите для параметра IsFolder значение true. Обязательный. Да Нет
ThumbnailUrl Строка Применяется только для вложенной ссылки на изображение, представляющей собой URL-адрес для доступа к эскизу этого изображения. Используйте свойства ThumbnailUrl и PreviewUrl, только когда SourceUrl указывает на файл изображения. Необязательный. Да Нет

Task

Тип: Microsoft.OutlookServices.Task

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

Для каждого из следующих свойств, связанных с датой:

  • CompletedDateTime
  • CreatedDateTime
  • DueDateTime
  • LastModifiedDateTime
  • ReminderDateTime
  • StartDateTime

Если данное свойство установлено, то по умолчанию REST API задачи возвращает значение, имеющее формат UTC, в ответе REST. Узнайте больше о настройке StartDateTime и DueDateTime, а также свойствах, связанных с возвращением даты в настраиваемом часовом поясе.

Свойство Type Описание Подлежит записи? Фильтруемое?
AssignedTo Строка Имя человека, которому назначена задача. Нет Да
Attachments Коллекция (Attachment) Коллекция вложений FileAttachment и ItemAttachment для задачи. Свойство навигации. Нет Нет
Body ItemBody Тело задачи, которое, как правило, содержит информацию о задаче. Обратите внимание, что поддерживается только тип HTML. Да Нет
Categories Коллекция (Строка) Категории, связанные с задачей. Да Да
ChangeKey Строка Версия задачи. Нет Нет
CompletedDateTime DateTimeTimeZone Дата завершения задачи в указанном часовом поясе. Да Да
CreatedDateTime DateTimeOffset Дата и время создания задачи. По умолчанию время указывается в формате UTC. Пользователь может указать настраиваемый часовой пояс в заголовке запроса. Нет Да
DueDateTime DateTimeTimeZone Дата планируемого завершения задачи в указанном часовом поясе. Да Да
HasAttachments Логическое Если задача имеет вложения, этому свойству присваивается значение true. Нет Да
Id Строка Уникальный идентификатор задачи. Нет Нет
Importance Importance Важность события: Low, Normal, High. Да Да
IsReminderOn Логическое Если для напоминания пользователю о задаче установлено оповещение, то данному свойству присваивается значение true. Да Нет
LastModifiedDateTime DateTimeOffset Дата и время последнего изменения задачи. По умолчанию время указывается в формате UTC. Пользователь может указать настраиваемый часовой пояс в заголовке запроса. Нет Да
Owner Строка Имя человека, создавшего задачу. Нет Да
ParentFolderId Строка Уникальный идентификатор родительской папки задачи. Нет Нет
Recurrence PatternedRecurrence Расписание повторения для задачи. Да Нет
ReminderDateTime DateTimeTimeZone Дата и время появления оповещения с напоминанием о задаче. Да Нет
Sensitivity Sensitivity Указывает уровень конфиденциальности события: Normal, Personal, Private, Confidential. Да Да
StartDateTime DateTimeTimeZone Дата начала задачи в указанном часовом поясе. Да Да
Status TaskStatus Характеризует состояние или ход выполнения задачи: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred. Да Да
Subject Строка Краткое описание или название задачи. Да Да

Папка задач

Тип: Microsoft.OutlookServices.TaskFolder

Папка, содержащая задачи. В Outlook группа задач по умолчанию My Tasks содержит папку задач по умолчанию Tasks для почтового ящика пользователя. Переименовать или удалить эту используемую по умолчанию группу и папку задач невозможно, однако пользователь может создавать дополнительные группы и папки задач.

Свойство Type Описание Подлежит записи? Фильтруемое?
ChangeKey Строка Версия папки задач. Нет Нет
Id Строка Уникальный идентификатор папки задач. Нет Нет
IsDefaultFolder Логическое True, если папка является папкой задач по умолчанию. Нет Да
Name Строка Имя папки задач. Да Да
ParentGroupKey Edm.Guid Уникальный идентификатор GUID для родительской группы папки задач. Нет Нет
Tasks Коллекция (Task) Задачи в этой папке задач. Свойство навигации. Нет Нет

TaskGroup

Тип: Microsoft.OutlookServices.TaskGroup

Группа папок, содержащих задачи. В Outlook существует группа задач по умолчанию My Tasks, которую невозможно переименовать или удалить. Тем не менее, пользователь может создавать дополнительные группы задач.

Свойство Type Описание Подлежит записи? Фильтруемое?
ChangeKey Строка Версия группы задач. Нет Нет
GroupKey Edm.Guid Уникальный идентификатор GUID для группы задач. Нет Нет
Id Строка Уникальный идентификатор группы задач. Нет Нет
IsDefaultGroup Логическое True, если группа задач является группой задач по умолчанию. Нет Да
Name Строка Имя группы задач. Да Да
TaskFolders Коллекция(TaskFolder) Папки задач в этой группе задач. Свойство навигации. Нет Нет

Пользователь

Пользователь в системе. Конечная точка Me предоставляется в качестве ярлыка для указания текущего пользователя по SMTP-адресу ( users/sadie@contoso.com).

Тип: Microsoft.OutlookServices.User

Коллекция Users возвращает массив пользователей в свойстве value ответа OData. Используйте $count, чтобы получить общее число объектов в коллекции: .../me/users/$count

Примечание

Объект User включает в себя множество свойств и связей (свойства навигации), которые часто обновляются. В следующем разделе описываются только подмножество. Для получения текущей информации см. определение User в соответствующем вашей версии файле метаданных.

Свойство Type Описание Подлежит записи? Фильтруемое?
Alias Строка Псевдоним пользователя. Обычно это SMTP-адрес пользователя. Да Да
Calendar Calendar Основной календарь пользователя. Свойство навигации. Нет Нет
CalendarGroups Коллекция(CalendarGroup) Группы календарей пользователя. Свойство навигации. Нет Нет
Calendars Коллекция (Calendar) Календари пользователей. Свойство навигации. Нет Нет
CalendarView Коллекция (Event) Представление календаря для календаря. Свойство навигации. Нет Нет
ContactFolders Коллекция (ContactFolder) Папки контактов пользователя. Свойство навигации. Нет Нет
Contacts Коллекция (Contact) Контакты пользователя. Свойство навигации. Нет Нет
DisplayName Строка Отображаемое имя пользователя. Да Да
Events Коллекция (Event) События пользователя. Значение по умолчанию: показывать события в календаре по умолчанию. Свойство навигации. Нет Нет
Id Строка Уникальный идентификатор для пользователя. Нет Нет
InferenceClassification InferenceClassification Классификация релевантности для сообщений пользователя, основанная на явных обозначениях, переопределяющих заданные релевантность или важность. Свойство навигации. Да Да
MailboxGuid guid GUID, назначенный почтовому ящику пользователя. Нет Да
MailboxSettings MailboxSettings Параметры основного почтового ящика пользователя, вошедшего в систему. Да Нет
MailFolders Коллекция(MailFolder) Папки в почтовом ящике. Свойство навигации. Нет Нет
Messages Коллекция (Message) Сообщения в почтовом ящике или папке. Свойство навигации. Нет Нет
RootFolder MailFolder Корневая папка почтового ящика пользователя. Свойство навигации. Нет Нет

Сложные типы

Attendee

Участник события.

Тип: Microsoft.OutlookServices.Recipient

Свойство Type Описание
Status ResponseStatus Ответ (нет, принят, отклонен и т. д.) и время.
Type AttendeeType Тип участника. Возможные значения: Required, Optional, Resource.

AttendeeAvailability

Тип и доступность участника.

Тип: Microsoft.OutlookServices.AttendeeAvailability

Свойство Type Описание
Attendee AttendeeBase Тип участника — будь то человек или ресурс.
Availability FreeBusyStatus Состояние доступности участника.

AttendeeBase

Тип участника.

Тип: Microsoft.OutlookServices.Recipient

Свойство Type Описание
Type AttendeeType Тип участника. Возможные значения: Required, Optional, Resource. ПРИМЕЧАНИЕ. Если участник является человеком, то FindMeetingTimes всегда предполагает, что человек имеет тип Required.

AutomaticRepliesSetting

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

Тип: Microsoft.OutlookServices.AutomaticRepliesSetting

Свойство Type Описание
ExternalAudience ExternalAudienceScope Внешняя аудитория по отношению к организации пользователя, выполнившего вход, которая получит сообщение ExternalReplyMessage, если для параметра Status задано значение AlwaysEnabled или Scheduled. Значения None = 0, ContactsOnly = 1 или All = 2.
ExternalReplyMessage Строка Автоматический ответ, который нужно отправить указанной внешней аудитории, если параметру Status присвоено значение AlwaysEnabled или Scheduled.
InternalReplyMessage Строка Автоматический ответ, который нужно отправить сотрудникам организации пользователя, выполнившего вход, если для параметра Status задано значение AlwaysEnabled или Scheduled.
ScheduledEndDateTime DateTimeTimeZone Дата и время завершения отправки автоматических ответов, если для параметра Status установлено значение Scheduled. Часовой пояс можно установить с помощью заголовка HTTP Prefer: outlook.timezone в операции Get.
ScheduledStartDateTime DateTimeTimeZone Дата и время начала отправки автоматических ответов, если для параметра Status установлено значение Scheduled. Часовой пояс можно установить с помощью заголовка HTTP Prefer: outlook.timezone в операции Get.
Status AutomaticRepliesStatus Состояние конфигурации для автоматических ответов: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

DateTimeTimeZone

Описывает дату, время и часовой пояс для определенного момента.

Свойство Type Описание
DateTime DateTime Единая точка времени в комбинированном представлении даты и времени (<date>T<time>) согласно формату ISO 8601.
TimeZone Строка Один из указанных ниже часовых поясов.

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

Etc/GMT+12

Etc/GMT+11

Pacific/Honolulu

America/Anchorage

America/Santa_Isabel

America/Los_Angeles

America/Phoenix

America/Chihuahua

America/Denver

America/Guatemala

America/Chicago

America/Mexico_City

America/Regina

America/Bogota

America/New_York

America/Indiana/Indianapolis

America/Caracas

America/Asuncion

America/Halifax

America/Cuiaba

America/La_Paz

America/Santiago

America/St_Johns

America/Sao_Paulo

America/Argentina/Buenos_Aires

America/Cayenne

America/Godthab

America/Montevideo

America/Bahia

Etc/GMT+2

Atlantic/Azores

Atlantic/Cape_Verde

Africa/Casablanca

Etc/GMT

Europe/London

Atlantic/Reykjavik

Europe/Berlin

Europe/Budapest

Europe/Paris

Europe/Warsaw

Africa/Lagos

Africa/Windhoek

Europe/Bucharest

Asia/Beirut

Africa/Cairo

Asia/Damascus

Africa/Johannesburg

Europe/Kiev

Europe/Istanbul

Asia/Jerusalem

Asia/Amman

Asia/Baghdad

Europe/Kaliningrad

Asia/Riyadh

Africa/Nairobi

Asia/Tehran

Asia/Dubai

Asia/Baku

Europe/Moscow

Indian/Mauritius

Asia/Tbilisi

Asia/Yerevan

Asia/Kabul

Asia/Karachi

Asia/Tashkent

Asia/Kolkata

Asia/Colombo

Asia/Kathmandu

Asia/Almaty

Asia/Dhaka

Asia/Yekaterinburg

Asia/Rangoon

Asia/Bangkok

Asia/Novosibirsk

Asia/Shanghai

Asia/Krasnoyarsk

Asia/Singapore

Australia/Perth

Asia/Taipei

Asia/Ulaanbaatar

Asia/Irkutsk

Asia/Tokyo

Asia/Seoul

Australia/Adelaide

Australia/Darwin

Australia/Brisbane

Australia/Sydney

Pacific/Port_Moresby

Australia/Hobart

Asia/Yakutsk

Pacific/Guadalcanal

Asia/Vladivostok

Pacific/Auckland

Etc/GMT-12

Pacific/Fiji

Asia/Magadan

Pacific/Tongatapu

Pacific/Apia

Pacific/Kiritimati

EmailAddress

Имя и электронный адрес контакта или получателя сообщения.

Тип: Microsoft.OutlookServices.EmailAddress

Свойство Type Описание
Name Строка Отображаемое имя человека или объекта.
Address Строка Электронный адрес человека или объекта.

GeoCoordinates

Географические координаты и высота расположения.

Тип: Microsoft.OutlookServices.GeoCoordinates

Свойство Type Описание
Altitude Двойной Высота расположения.
Latitude Двойной Широта расположения.
Longitude Двойной Долгота расположения.
Accuracy Двойной Точность датчика, предоставляющего данные о широте и долготе.
AltitudeAccuracy Двойной Точность датчика, предоставляющего данные о высоте.

ItemBody

Содержимое текста сообщения или события.

Тип: Microsoft.OutlookServices.ItemBody

Свойство Type Описание
ContentType BodyType Тип содержимого: Текст = 0, HTML = 1.
Content Строка Содержимое в текстовом формате или формате HTML.

LocaleInfo

Сведения о языковом стандарте, в частности предпочтительном языке и стране/регионе, вошедшего в систему пользователя.

Тип: Microsoft.OutlookServices.LocaleInfo

Свойство Type Описание
DisplayName Строка Название, отображающее языковой стандарт на его естественном языке, например, «English (United States)».
Locale Строка Представление языкового стандарта, включающее в себя язык и страну/регион. Например, «en-us». Языковой компонент характеризуется кодами из двух букв, определенными в стандарте ISO 639-1, а компонент страны — кодами из двух букв, определенными в стандарте ISO 3166-1 alpha-2.

Location

Расположение события.

Тип: Microsoft.OutlookServices.Location

Свойство Type Описание
DisplayName Строка Имя, связанное с расположением.
Address PhysicalAddress Физический адрес расположения.
Координаты GeoCoordinates Географические координаты и высота расположения.
LocationEmailAddress Строка Необязательный адрес электронной почты расположения.

LocationConstraint

Условия, заданные клиентом в отношении расположения для проведения собрания.

Тип: Microsoft.OutlookServices.LocationConstraint

Свойство Type Описание
IsRequired Логическое Клиент запрашивает службу включить в ответ место проведения собрания.
SuggestLocation Логическое Клиент запрашивает у службы один или несколько вариантов расположений для проведения собрания.
Locations Коллекция(LocationConstraintItem) Одно или несколько мест, которые клиент запрашивает для проведения собрания.

LocationConstraintItem

Условия, указанные клиентом для проверки доступности каждого места проведения собрания, а также другая информация о расположении.

Тип: Microsoft.OutlookServices.Location

Свойство Type Описание
ResolveAvailability Логическое Если установлено значение true и указанный ресурс занят, действие FindMeetingTimes ищет другой свободный ресурс. Если этому свойству присвоено значение false, а указанный ресурс занят, то FindMeetingTimes возвращает ресурс, получивший наивысшую оценку в кэше пользователя, не проверяя, свободен ли он. По умолчанию true.

MailboxSettings

Параметры основного почтового ящика пользователя.

Тип: Microsoft.OutlookServices.MailboxSettings

Свойство Type Описание
AutomaticRepliesSetting AutomaticRepliesSetting Параметры для настройки автоматической отправки ответов на входящие сообщения.
TimeZone Строка Часовой пояс почтового ящика пользователя по умолчанию.
Language LocaleInfo Сведения о языковом стандарте пользователя, в том числе о предпочитаемом языке и стране или регионе.

MeetingTimeSuggestion

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

Тип: Microsoft.OutlookServices.MeetingTimeSuggestion

Свойство Type Описание
MeetingTimeSlot TimeSlot Период времени, предложенный для собрания.
Confidence Двойной Процент вероятности того, что все участники будут присутствовать на собрании.
OrganizerAvailability FreeBusyStatus Доступность организатора собрания для этого варианта собрания: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailability Коллекция (AttendeeAvailability) Массив, показывающий состояние доступности каждого участника для этого варианта собрания.
Locations Коллекция (Location) Массив, в котором указано имя и географические данные каждого расположения для проведения этого варианта собрания.
SuggestionReason Строка Описывает причины предложения времени собрания.

Вероятность собрания

Свойство Confidence объекта MeetingTimeSuggestion принимает значения, изменяющиеся в диапазоне от 0 % до 100 %, и характеризует вероятность того, что все участники будут присутствовать на собрании, определяющуюся сведениями о доступности каждого участника:

  • Если тот или иной участник доступен в указанный период времени, для него задается вероятность посещения 100 %, если его состояние неизвестно — 49 %, а если он занят— 0 %.
  • Достоверность времени возможного проведения собрания вычисляется, как средняя вероятность присутствия всех указанных участников собрания.
  • Вы можете использовать необязательный параметр MinimumAttendeePercentage для действия FindMeetingTimes чтобы указать необходимость возвращения только таких временных интервалов собрания, которые соответствуют минимальному уровню достоверности посещения. Например, можно указать для параметра MinimumAttendeePercentage значение 80 %, если требуется получить только варианты, для которых вероятность того, что все участники посетят собрание, будет равна 80 %. Если вы не задали значение MinimumAttendeePercentage, действие FindMeetingTimes предполагает, что значение равно 50 %.
  • Если существует несколько возможных вариантов времени встречи, действие FindMeetingTimes сначала упорядочивает варианты по рассчитанному для них значению вероятности (от высокого к низкому). Если есть варианты с одинаковой вероятностью, действие в следующую очередь упорядочивает варианты в хронологическом порядке.

Как пример, рассмотрим ситуацию, когда в период времени для проведения собрания предполагается присутствие трех участников со следующими состояниями доступности:

Attendee Сведения о доступности Процентная вероятность посещения
Дарья Свободна 100 %
Иван Unknown (Неизвестно) 49 %
Лилия Busy (Занят) 0 %

В этом случае достоверность предлагаемого периода времени для проведения собрания, представляющая собой среднюю вероятность посещения, составляет (100 % + 49 % + 0 %)/3 = 49,66 %.

Если указать для параметра MinimumAttendeePercentage в методе FindMeetingTimes значение 80 %, операция не будет предлагать этот период времени в ответе, так как 49,66 % < 80 %.

MeetingTimeSuggestionsResult

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

Тип: Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Свойство Type Описание
MeetingTimeSuggestions Коллекция (MeetingTimeSuggestion) Массив предложений, касающихся собрания.
EmptySuggestionsReason Строка Причина отсутствия предложений в результатах. Возможные значения: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown и Unknown.

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

Свойство EmptySuggestionsReason определяет одну из следующих причин того, что действие FindMeetingTimes не возвращает никаких вариантов собраний. Данное свойство представляет собой пустую строку, если FindMeetingTimes возвращает какие-либо предложения по проведению собрания.

Value Причины
AttendeesUnavailable Имеются сведения о доступности всех участников, но не достигнут порог достоверности собрания (значение по умолчанию — 50 %).
AttendeesUnavailableOrUnknown Отсутствуют сведения о доступности некоторых или всех участников, из-за чего значение достоверности собрания становится ниже заданного порога (значение по умолчанию — 50 %). Доступность участника может стать неизвестной, если он находится за пределами организации или произошла ошибка при получении сведений о доступности.
LocationsUnavailable Свойство IsRequired параметра LocationConstraint указано как обязательное, но для рассчитанных периодов времени нет доступных площадок.
OrganizerUnavailable Параметру IsOrganizerOptional присвоено значение false, но организатор занят в течение запрашиваемого периода времени.
Unknown (Неизвестно) Причина отсутствия предложений неизвестна.

PatternedRecurrence

Расписание повторения и продолжительность.

Тип: Microsoft.OutlookServices.PatternedRecurrence

Свойство Type Описание
Pattern RecurrencePattern Частота события.
Range RecurrenceRange Продолжительность события.

PhysicalAddress

Физический адрес контакта.

Тип: Microsoft.OutlookServices.PhysicalAddress

Свойство Type Описание
Street Строка Улица.
City Строка Город.
State Строка Штат.
CountryOrRegion Строка Страна или регион. Это строковое значение в произвольном формате, например, «США».
PostalCode Строка Почтовый индекс.

Recipient

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

Тип: Microsoft.OutlookServices.Recipient

Свойство Type Описание
EmailAddress EmailAddress Электронный адрес получателя.

RecurrencePattern

Частота события.

Тип: Microsoft.OutlookServices.RecurrencePattern

Свойство Type Описание
Type RecurrencePatternType Тип расписания повторения: 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 Количество единиц заданного типа между повторениями.
DayOfMonth Int32 День месяца, в который возникает элемент.
Month Int32 Месяц, в котором возникает элемент. Это число от 1 до 12.
DaysOfWeek Коллекция(DayOfWeek) Коллекция дней недели: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6.
FirstDayOfWeek DayOfWeek Дни недели: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6.
Index WeekIndex Индекс недели: первая = 0, вторая = 1, третья = 2, четвертая = 3, последняя = 4.

RecurrenceRange

Продолжительность события.

Тип: Microsoft.OutlookServices.RecurrenceRange

Свойство Type Описание
Type RecurrenceRangeType Диапазон повторения: EndDate = 0, NoEnd = 1, Numbered = 2.
StartDate datetimeoffset Обязательное: дата начала последовательности.
EndDate datetimeoffset Требуется для привязанных к датам шаблонов: дата окончания последовательности. Должно быть после даты начала.
NumberOfOccurrences Int32 Требуется для нумерованных шаблонов: количество повторений события.

ResponseStatus

Состояние ответа к приглашению на собрание.

Тип: Microsoft.OutlookServices.ResponseStatus

Свойство Type Описание
Response ResponseType Тип ответа: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Time datetimeoffset Дата и время возвращения ответа.

TimeConstraint

Ограничивает предложения по времени проведения собрания определенными часами и днями недели в соответствии с указанным характером действия и доступными периодами времени.

Тип: Microsoft.OutlookServices.TimeConstraint

Свойство Type Описание
ActivityDomain ActivityDomain Необязательно, характер действия: Work, Personal, Unrestricted или Unknown.
Временные интервалы Коллекция (TimeSlot) Массив, содержащий значения периодов времени.

TimeSlot

Период времени.

Тип: Microsoft.OutlookServices.TimeSlot

Свойство Type Описание
Start DateTimeTimeZone Время начала периода.
End DateTimeTimeZone Время окончания периода.

Перечисления

ActivityDomain

Характер деятельности.

Поддерживаемые значения:

  • Work (Рабочая)
  • Personal (Личное)
  • Unrestricted (Без ограничений)
  • Unknown (Неизвестно)

AutomaticRepliesStatus

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

Поддерживаемые значения:

  • AlwaysEnabled
  • Disabled
  • Scheduled

DayOfWeek

Множество дней недели.

Поддерживаемые значения:

  • Sunday (Воскресенье)
  • Monday (Понедельник)
  • Tuesday (Вторник)
  • Wednesday (Среда)
  • Thursday (Четверг)
  • Friday (Пятница)
  • Saturday (Суббота)

ExternalAudienceScope

Множество внешней аудитории для отправки сообщения ExternalReplyMessage.

Поддерживаемые значения:

  • All (Все)
  • ContactsOnly (Только контакты)
  • None (Никто)

FreeBusyStatus

Характеризует состояние доступности участника собрания.

Поддерживаемые значения:

  • Busy (Занят)
  • Free (Свободен)
  • Oof (Нет на месте)
  • Tentative (Под вопросом)
  • Unknown (Неизвестно)
  • WorkingElsewhere (Работаю в другом месте)

InferenceClassificationType

Представляет предполагаемую релевантность сообщения для пользователя.

Поддерживаемые значения:

  • Focused (Важное)
  • Other

ReferenceAttachmentPermissions

Разрешения доступа к файлу или папке вложенной ссылки.

Поддерживаемые значения:

  • Other
  • View
  • Edit
  • AnonymousView
  • AnonymousEdit
  • OrganizationView
  • OrganizationEdit

ReferenceAttachmentProviders

Возможные поставщики хранилищ файлов для вложенных ссылок.

Поддерживаемые значения:

  • Dropbox
  • OneDriveBusiness
  • OneDriveConsumer
  • Other

Sensitivity

Указывает уровень конфиденциальности.

Поддерживаемые значения:

  • Normal (Обычный)
  • Personal (Личное)
  • Private (Частное)
  • Confidential (Конфиденциально)

TaskStatus

Определяет состояние или ход выполнения задачи.

Поддерживаемые значения:

  • Completed
  • Deferred
  • InProgress
  • NotStarted
  • WaitingOnOthers

Параметры запросов OData

Для фильтрации запросов данных, сортировки и отображения результатов на странице при работе с API почты, календаря и контактов можно использовать стандартные параметры запроса OData версии 4.0. При указании параметров запроса убедитесь, что символы, которые зарезервированы для специальных значений в URI, закодированы надлежащим образом.

  • $search для поиска конкретных критериев

  • $filter для фильтрации по конкретным критериям

  • $select длязапроса определенных свойств

  • $orderby для сортировки результатов

  • $top и $skip для отображения результатов на странице

  • $expand для расширения вложений сообщения и вложений события

  • $count для получения сведений о количестве объектов в коллекции. Этот параметр указан в URL-адресе: .../me/calendars/$count

При выполнение запросов с помощью API Почты, Календаря и Контактов всегда используется неглубокая область видимости. Возвращаются только элементы в текущей папке. Глубокие поисковые запросы не поддерживаются.

Поисковые запросы

Чтобы ограничить результаты запроса сообщениями, соответствующими поисковому выражению, можно использовать параметр $search. Строки поиска указываются с использованием расширенного синтаксиса запросов (AQS). Результаты сортируются по дате и времени отправки сообщения.

Примечание

После подачи запроса $search можно получить более 250 результатов. $search можно использовать только с сообщениями. Поиск контактов и событий календаря не поддерживается.

Использование $filter или $orderby в поисковом запросе не допускается. В противном случае, выдается сообщение об ошибке, подобное тому, которое указано ниже.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }
Свойство Описание
Вложение Поиск указанного вложения по названию.
Bcc Поиск поля Скрытая копия.
Body или Content Поиск поля Body. Поддерживается только c поисковыми запросами по умолчанию.
Category Поиск поля Категория.
Cc Поиск поля копии.
From Поиск поля From.
Has Поиск поля HasAttachments.
Participants Поиск полей To, Cc и Bcc.
Received Поиск поля Received для конкретной даты, указанной в виде ММ/ДД/ГГГГ.
Sender Поиск поля Sender.
Subject Поиск поля Subject.
To Поиск поля Кому.

Поиск общих полей выполняется с помощью параметра запроса $search без указания свойства. При поиске по умолчанию ищутся свойства Body, Sender и Subject. Следующий поиск возвращает все сообщения в папке «Входящие», которые содержат слово «pizza» в любом из трех свойств по умолчанию.

Давайте посмотрим на некоторые примеры. Для простоты URL-адреса в примерах не были закодированы в URL; однако если вы попробуете использовать эти примеры, обязательно используйте кодировку URL перед отправкой их на сервер.

Для получения всех сообщений в папке «Входящие», содержащих слово «Pizza» в свойстве From, Subject или Body, можно использовать этот запрос.

GET https://outlook.office.com/api/v2.0/me/messages?$search="pizza"

Чтобы получить все сообщения в папке «Входящие», содержащие слово «Pizza» в свойстве Subject, можно использовать этот запрос.

GET https://outlook.office.com/api/v2.0/me/messages?$search="subject:pizza"

Чтобы получить все сообщения в папке «Входящие», которые были отправлены от определенного человека, можно использовать этот запрос.

GET https://outlook.office.com/api/v2.0/me/messages?$search="from:help@contoso.com"

В приведенных выше примерах кодировка URL-адреса не применялась. Здесь приводятся те же примеры с закодированым URL-адресом, готовые к отправке на ваш сервер:

GET https://outlook.office.com/api/v2.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v2.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v2.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."
      }
    }
Оператор Type Пример
and Логическое «и» (используется для объединения нескольких условий) TotalCount gt 0 and ChildFolderCount eq 0
or Логическое «Или» (используется для объединения нескольких условий) TotalCount gt 0 or ChildFolderCount eq 0
eq Равно IsRead eq false
ne Не равно Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt Больше ReceivedDateTime gt 2014-09-01T00:00:00Z
ge Больше или равно LastModifiedDateTime ge 2014-09-01T00:00:00Z
lt Меньше ReceivedDateTime lt 2014-09-01T00:00:00Z
le Меньше или равно LastModifiedDateTime le 2014-09-01T00:00:00Z

Используйте одинарные кавычки (') для указания в качестве условий поиска любых строковых значений. Используйте %27 для URL-кодирования одинарных кавычек. Сама строка не чувствительна к регистру.

Давайте посмотрим на некоторые примеры. Для простоты URL-адреса в примерах не были закодированы в URL; однако если вы попробуете использовать эти примеры, обязательно используйте кодировку URL перед отправкой их на сервер.

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

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'

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

GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject eq 'Mega Charity Bash'

Чтобы получить все непрочитанные сообщения в папке «Входящие», можно фильтровать по свойству IsRead.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead eq false

Чтобы получить все сообщения с вложениями, имеющиеся в папке «Входящие», можно выполнить фильтрацию по свойству HasAttachments.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments eq true

Чтобы получить все сообщения в папке «Входящие», полученные с 1 сентября 2014 года, можно фильтровать по свойству ReceivedDateTime.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime ge 2014-09-01

Чтобы получить все имеющиеся в папке «Входящие» сообщения, отправленные с адреса «hr@contoso.com», выполнить фильтрацию по свойству Sender.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

В приведенных выше примерах кодировка URL-адреса не применялась. Здесь приводятся те же примеры с закодированым URL-адресом, готовые к отправке на ваш сервер:

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

Выберите конкретные свойства, которые требуется вернуть

Чтобы указать только те свойства, которые необходимы вашему приложению, можно использовать параметр запроса $select.

Примечание

При получении элементов почты, календаря и контактов всегда используйте параметр $select для исключения ненужных свойств из содержащихся в ответе полезных данных, чтобы поддерживать производительность приложения на требуемом уровне. Без применения параметра $select возвращаются все свойства элементов.

В следующем примере выполняется получение свойств Subject, Sender и ReceivedDateTime для всех сообщений в папке «Входящие».

GET https://outlook.office.com/api/v2.0/me/messages?$select=Subject,Sender,ReceivedDateTime

Сортировка результатов

Результаты можно сортировать с помощью параметра запроса $orderby. Задайте имя свойства в качестве значения этого параметра и, дополнительно, укажите, следует ли выполнить сортировку по возрастанию (по умолчанию) или по убыванию. Помните о том, что использование параметра запроса $orderby с $search не допускается.

В следующем примере без кодирования URL-адреса производится получение всех сообщений, имеющихся в папке «Входящие» и отсортированных по свойству ReceivedDateTime в порядке убывания.

GET https://outlook.office.com/api/v2.0/me/messages?$orderby=ReceivedDateTime desc

Тот же пример с кодировкой URL:

GET https://outlook.office.com/api/v2.0/me/messages?$orderby=ReceivedDateTime%20desc

Страница результатов

По умолчанию запрос GET, выполненный для свойств Messages или ChildFolders, коллекции, или CalendarView, возвращает десять записей (максимум, 50). Это можно изменить с помощью параметра запроса $top, что позволит установить максимальное количество. В следующем примере показана процедура получения первых пяти сообщений, содержащихся в папке «Входящие».

GET https://outlook.office.com/api/v2.0/me/messages?$top=5

Если в папке «Входящие» находится более пяти сообщений, ответ включает свойство odata.nextLink. Наличие этого свойства указывает на то, что на сервере доступны дополнительные элементы. Значение этого свойства представляет собой URI, который можно использовать для получения следующих пяти элементов.

GET https://outlook.office.com/api/v2.0/me/messages?$top=5&$skip=5

Разбиение по страницам производится с помощью параметра $top, позволяющего указать размер страницы, и параметра $skip, характеризующего кратность размеру страницы. Увеличивая значение параметра $skip на величину размера страницы, можно произвести запрос следующей страницы в наборе результатов.

Подсчет объектов в коллекции

Количество объектов в коллекции можно получить с помощью параметра $count. Запрос количества также можно фильтровать.

В этом примере отображается количество сообщений в папке «Входящие».

GET https://outlook.office.com/api/v2.0/me/messages/$count

А в этом примере без кодировки URL возвращается количество непрочитанных сообщений в папке «Входящие».

GET https://outlook.office.com/api/v2.0/me/messages/$count?$filter=IsRead eq false

Тот же пример с кодированием URL-адреса.

GET https://outlook.office.com/api/v2.0/me/messages/$count?$filter=IsRead%20eq%20false

Подведение итогов

Вы можете комбинировать параметры для создания сложных запросов. В примере ниже создается более точный запрос сообщений в папке «Входящие» следующими способами.

  • Возвращаются только те элементы, свойству Importance которых присвоено значение High.

  • Возврат только свойств Subject, Sender и ReceivedDateTime.

  • Возвращаются только первые пять сообщений.

Примечание

Кодирование URL-адреса в данном случае не используется. Чтобы сделать пример удобочитаемым, были добавлены разрывы строк.

https://outlook.office.com/api/v2.0/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,ReceivedDateTime
    &$top=5

При указании $filter порядок сортировки результатов определяется сервером. При одновлеменном использовании $filter и $orderby свойства в $filter следует указать в $orderby перед всеми другими свойствами и привести их в том порядке, в котором они представлены в параметре $filter.

В следующем параметре показан запрос, отфильтрованный по свойствам Subject и Importance, а затем отсортированный по свойствам Subject, Importance и Sender

https://outlook.office.com/api/v2.0/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Здесь приводятся те же примеры с кодированием URL-адреса и без разрывов строк.

https://outlook.office.com/api/v2.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5

https://outlook.office.com/api/v2.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

См. также