События Microsoft Outlook

Мақала
05/23/2024

В этой статье содержатся свойства и схема событий Microsoft Outlook, публикуемые API Microsoft Graph. Общие сведения о схемах событий см. в разделе Схема CloudEvents.

Доступные типы событий

Имя события	Description
Microsoft.Graph.EventCreated	Активируется при создании события в Outlook.
Microsoft.Graph.EventUpdated	Активируется при обновлении события в Outlook.
Microsoft.Graph.EventDeleted	Активируется при удалении события в Outlook.
Microsoft.Graph.ContactCreated	Активируется при создании контакта в Outlook.
Microsoft.Graph.ContactUpdated	Активируется при обновлении контакта в Outlook.
Microsoft.Graph.ContactDeleted	Активируется при удалении контакта в Outlook.
Microsoft.Graph.MessageCreated	Активируется при создании сообщения в Outlook.
Microsoft.Graph.MessageUpdated	Активируется при обновлении сообщения в Outlook.
Microsoft.Graph.MessageDeleted	Активируется при удалении сообщения в Outlook.

Пример события

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

Событие Microsoft.Graph.EventCreated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.EventCreated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Events/<event-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "created",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<event id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
			"@odata.type": "#Microsoft.OutlookServices.Event",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.EventUpdated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.EventUpdated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Events/<event-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "updated",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<event id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
			"@odata.type": "#Microsoft.OutlookServices.Event",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.EventDeleted

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.EventDeleted",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Events/<event-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "deleted",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<event id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
			"@odata.type": "#Microsoft.OutlookServices.Event",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.ContactCreated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.ContactCreated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Contacts/<contact-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "created",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<contact id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
			"@odata.type": "#Microsoft.OutlookServices.Contact",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.ContactUpdated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.ContactUpdated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Contacts/<contact-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "updated",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<contact id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
			"@odata.type": "#Microsoft.OutlookServices.Contact",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.ContactDeleted

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.ContactDeleted",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Contacts/<contact-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "deleted",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<contact id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
			"@odata.type": "#Microsoft.OutlookServices.Contact",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.MessageCreated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.MessageCreated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Users/<user-id>/Messages/<messaeg-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "created",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "Users/<user-id>/Messages/<message-id>",
		"clientState": "<client state>",
		"tenantId":"<tenant-id>",
		"resourceData": {
			"Id": "<message id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "Users/<user-id>/Messages/<message-id>",
			"@odata.type": "#Microsoft.OutlookServices.Message",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.MessageUpdated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.MessageUpdated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Messages/<message-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "updated",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Messages('<message id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<message id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Messages('<message id>')",
			"@odata.type": "#Microsoft.OutlookServices.Message",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Событие Microsoft.Graph.MessageDeleted

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.MessageDeleted",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Message/<messaeg-id>",
	"time": "2024-05-22T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2024-06-22T23:56:30.1307708Z",
		"ChangeType": "deleted",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Messages('<message id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<message id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Messages('<message id>')",
			"@odata.type": "#Microsoft.OutlookServices.Message",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Свойства событий

Событие содержит следующие высокоуровневые данные:

Свойство	Type	Описание:
`source`	строка	Источник событий клиента. Это поле защищено от записи. Это значение предоставляет API Microsoft Graph.
`subject`	строка	Определенный издателем путь к субъекту события.
`type`	строка	Один из типов событий для этого источника событий.
`time`	строка	Время создания события определяется на основе времени поставщика в формате UTC.
`id`	строка	Уникальный идентификатор события.
`data`	объект	Полезные данные события, предоставляющие данные об изменении состояния ресурса.
`specversion`	строка	Версия спецификации схемы CloudEvents.

Объект данных имеет следующие свойства:

Свойство	Type	Описание:
`changeType`	строка	Тип изменения состояния ресурса.
`resource`	строка	Идентификатор ресурса, для которого было создано событие.
`tenantId`	строка	Идентификатор организации, в которой хранится пользователь или контакт.
`clientState`	строка	Секрет, предоставленный пользователем при создании подписки API Graph.
`@odata.type`	строка	Тип изменения API Graph.
`@odata.id`	строка	Идентификатор ресурса API Graph, для которого было создано событие.
`id`	строка	Идентификатор ресурса, для которого было создано событие.
`organizationId`	строка	Идентификатор арендатора Outlook.
`eventTime`	строка	Время возникновения состояния ресурса.
`sequenceNumber`	строка	Порядковый номер.
`subscriptionExpirationDateTime`	строка	Время запроса на изменение (RFC) 3339 , в котором истекает срок действия подписки API Graph.
`subscriptionId`	строка	Идентификатор подписки API Graph.
`tenantId`	строка	Идентификатор арендатора Outlook.
`otherResourceData`	строка	Заполнитель, представляющий одно или несколько динамических свойств, которые могут быть включены в событие.

Следующие шаги

Общие сведения о партнерских событиях Сетки событий Azure см. в Обзоре партнерских событий
Сведения о том, как подписаться на API Graph для получения событий Outlook, см. в статье Подписка на события API Graph Azure.
Сведения о обработчиках событий Сетки событий Azure см. в разделе обработчики событий.
Дополнительные сведения о создании подписки на Сетку событий Azure см. в статьях Создание подписки на события и Схема подписки на Сетку событий.
Сведения о настройке подписки на события для доставки определенных событий см. в разделе Фильтрация событий. Кроме того, может потребоваться ссылаться на события фильтрации.

Бөлісу құралы: