Создание подписки

Пространство имен: microsoft.graph

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

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

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

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

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

В зависимости от ресурса и типа требующегося разрешения (делегированное или для приложения) разрешение, указанное в приведенной ниже таблице, является наименее привилегированным разрешением, необходимым для вызова этого API. Чтобы узнать больше, в том числе, как соблюдать осторожность перед выбором разрешений, найдите следующие разрешения в Разрешениях.

Поддерживаемый ресурс	Делегированное (рабочая или учебная учетная запись)	Делегированное (личная учетная запись Майкрософт)	Application
callRecord (/communications/callRecords)	Не поддерживается	Не поддерживается	CallRecords.Read.All
callRecording communications/onlineMeetings/getAllRecordings Все записи в организации.	Не поддерживается.	Не поддерживается.	OnlineMeetingRecording.Read.All
callRecording communications/onlineMeetings/{onlineMeetingId}/recordings Все записи для определенного собрания.	OnlineMeetingRecording.Read.All	Не поддерживается.	OnlineMeetingRecording.Read.All
callRecording users/{userId}/onlineMeetings/getAllRecordings Запись звонка, которая становится доступной на собрании, организованном определенным пользователем.	OnlineMeetingRecording.Read.All	Не поддерживается.	OnlineMeetingRecording.Read.All
callTranscript communications/onlineMeetings/getAllTranscripts Все расшифровки в организации.	Не поддерживается.	Не поддерживается.	OnlineMeetingTranscript.Read.All
callTranscript communications/onlineMeetings/{onlineMeetingId}/transcripts Все стенограммы для определенного собрания.	OnlineMeetingTranscript.Read.All	Не поддерживается.	OnlineMeetingTranscript.Read.All
callTranscript users/{userId}/onlineMeetings/getAllTranscripts Расшифровка звонка, которая становится доступной на собрании, организованном определенным пользователем.	OnlineMeetingTranscript.Read.All	Не поддерживается.	OnlineMeetingTranscript.Read.All
channel (/teams/getAllChannels — все каналы в организации)	Не поддерживается	Не поддерживается	Channel.ReadBasic.All, ChannelSettings.Read.All
channel (/teams/{id}/channels)	Channel.ReadBasic.All, ChannelSettings.Read.All	Не поддерживается	Channel.ReadBasic.All, ChannelSettings.Read.All
чат (/чаты — все чаты в организации)	Не поддерживается	Не поддерживается	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
чат (/chats/{id})	Chat.ReadBasic, Chat.Read, Chat.ReadWrite	Не поддерживается	ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat /appCatalogs/teamsApps/{id}/installedToChats Все чаты в организации, где установлено определенное приложение Teams.	Не поддерживается	Не поддерживается	Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chatMessage (/teams/{id}/channels/{id}/messages)	ChannelMessage.Read.All	Не поддерживается	ChannelMessage.Read.Group*, ChannelMessage.Read.All
chatMessage (/teams/getAllMessages — все сообщения канала в организации)	Не поддерживается	Не поддерживается	ChannelMessage.Read.All
chatMessage (/chats/{id}/messages)	Chat.Read, Chat.ReadWrite	Не поддерживается	Chat.Read.All
chatMessage (/chats/getAllMessages — все сообщения чата в организации)	Не поддерживается	Не поддерживается	Chat.Read.All
chatMessage (/users/{id}/chats/getAllMessages — сообщения чата для всех чатов, в которые входит определенный пользователь)	Chat.Read, Chat.ReadWrite	Не поддерживается	Chat.Read.All, Chat.ReadWrite.All
chatMessage /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages Сообщения чата для всех чатов в организации, где установлено определенное приложение Teams.	Не поддерживается	Не поддерживается	Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact	Contacts.Read	Contacts.Read	Contacts.Read
conversationMember (/chats/getAllMembers)	Не поддерживается	Не поддерживается	ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember (/chats/{id}/members)	ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite	Не поддерживается	ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers Участники чата для всех чатов в организации, в которой установлено определенное приложение Teams.	Не поддерживается.	Не поддерживается.	ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember (/teams/{id}/members)	TeamMember.Read.All	Не поддерживается	TeamMember.Read.All
conversationMember (/teams/{id}/channels/getAllMembers)	Не поддерживается	Не поддерживается	ChannelMember.Read.All
driveItem (личное хранилище OneDrive пользователя)	Не поддерживается	Files.ReadWrite	Не поддерживается
driveItem (OneDrive для бизнеса)	Files.ReadWrite.All	Не поддерживается	Files.ReadWrite.All
event	Calendars.Read	Calendars.Read	Calendars.Read
group	Group.Read.All	Не поддерживается	Group.Read.All
group conversation	Group.Read.All	Не поддерживается	Не поддерживается
list	Sites.ReadWrite.All	Не поддерживается	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read	Mail.ReadBasic, Mail.Read	Mail.Read
presence	Presence.Read.All	Не поддерживается	Не поддерживается
printer	Не поддерживается	Не поддерживается	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	Не поддерживается	Не поддерживается	PrintTaskDefinition.ReadWrite.All
security alert	SecurityEvents.ReadWrite.All	Не поддерживается	SecurityEvents.ReadWrite.All
teams (/teams — все команды в организации)	Не поддерживается	Не поддерживается	Team.ReadBasic.All, TeamSettings.Read.All
team (/teams/{id})	Team.ReadBasic.All, TeamSettings.Read.All	Не поддерживается	Team.ReadBasic.All, TeamSettings.Read.All
todoTask	Tasks.ReadWrite	Tasks.ReadWrite	Не поддерживается
user	User.Read.All	User.Read.All	User.Read.All
virtualEventWebinar	VirtualEvent.Read	Не поддерживается.	VirtualEvent.Read.All

Рекомендуется использовать разрешения, как описано в предыдущей таблице. Из-за ограничений безопасности подписки Microsoft Graph не поддерживают разрешения на доступ на запись, если требуются только разрешения на чтение.

Примечание. Разрешения, помеченные звездочкой (*), используют согласие для конкретных ресурсов.

chatMessage

Подписки chatMessage можно указать, чтобы включить данные ресурсов. Если задано включение данных ресурсов (includeResourceData имеет значение true), требуется шифрование. Подписку нельзя создать, если для таких подписок не указан encryptionCertificate.

Необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующие значения в перечислении chatMessagemessageTypeс возможностью развития: systemEventMessage for /teams/{id}/channels/{id}/messages и /chats/{id}/messages resource.

Примечание.

/teams/getAllMessages, /chats/getAllMessages, /me/chats/getAllMessages, /users/{id}/chats/getAllMessagesи /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages являются лимитными API; могут применяться модели оплаты и требования к лицензированию . /teams/getAllMessages и /chats/getAllMessages поддерживают как model=Amodel=B модели оплаты, /me/chats/getAllMessagesтак и , /users/{id}/chats/getAllMessagesи /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages поддерживают только model=B. Если в запросе не указана модель оплаты, будет использоваться режим оценки по умолчанию.

Примечание.

Чтобы добавить или изменить модель оплаты для подписанного ресурса уведомления об изменениях, необходимо создать новую подписку на уведомление об изменениях с новой моделью оплаты. Обновление существующего уведомления об изменениях не работает.

conversationMember

Подписки conversationMember можно указать для включения данных ресурсов. Если задано включение данных ресурсов (includeResourceData имеет значение true), требуется шифрование. Создание подписки завершается сбоем, если не указан encryptionCertificate.

Примечание.

/teams/getAllMembers, /chats/getAllMembersи /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers являются лимитными API- интерфейсами; могут применяться модели оплаты и требования к лицензированию . /teams/getAllMembers и /chats/getAllMembers поддерживают как модели оплаты, так model=A и model=B . /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers поддерживает только model=B. Если в запросе не указана модель оплаты, будет использоваться режим оценки по умолчанию.

Примечание.

Чтобы добавить или изменить модель оплаты для подписанного ресурса уведомления об изменениях, необходимо создать новую подписку на уведомление об изменениях с новой моделью оплаты. Обновление существующего уведомления об изменениях не работает.

команда, канал и чат

Подписки на команды, каналы и чат можно указать для включения данных ресурсов. Если задано включение данных ресурсов (includeResourceData имеет значение true), требуется шифрование. Создание подписки завершается сбоем, если не указан encryptionCertificate.

Примечание.

/appCatalogs/teamsApps/{id}/installedToChats имеет требования к лицензированию и оплате, в частности, поддерживает только model=B. Если модель не указана, будет использоваться режим оценки.

Примечание.

Чтобы добавить или изменить модель оплаты для подписанного ресурса уведомления об изменениях, необходимо создать новую подписку на уведомление об изменениях с новой моделью оплаты. Обновление существующего уведомления об изменениях не работает.

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

Укажите параметр запроса model в свойстве ресурса в тексте запроса.

POST https://graph.microsoft.com/v1.0/subscriptions
Content-type: application/json

{
   "changeType": "created",
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
   "resource": "chats/getAllMessages?model=A",
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
   "clientState": "secretClientValue",
   "latestSupportedTlsVersion": "v1_2"
}

driveItem

Дополнительные ограничения применяются к подпискам на элементы OneDrive. Ограничения применяются для создания, а также управления (получение, обновление и удаление) подписками.

В личном хранилище OneDrive можно подписаться на корневую папку или любую вложенную папку в этом хранилище. В OneDrive для бизнеса можно подписаться только на корневую папку. Уведомления об изменениях отправляются для определенных типов изменений папки, на которую оформлена подписка, любого файла, папки или других экземпляров driveItem в ее иерархии. Вы не можете подписаться на экземпляры drive или driveItem , которые не являются папками, например на отдельные файлы.

OneDrive для бизнеса и SharePoint поддерживают отправку уведомлений приложений о событиях безопасности, которые происходят в driveItem. Чтобы подписаться на эти события, добавьте заголовок prefer:includesecuritywebhooks в запрос на создание подписки. После создания подписки вы будете получать уведомления об изменениях разрешений для элемента. Этот заголовок можно использовать в SharePoint и OneDrive для бизнеса, но не в учетных записях потребителей в OneDrive.

contact, event и message

Вы можете подписаться на изменения ресурсов Outlook contact, event или message.

Для операций создания и управления (получение, обновление и удаление) подписке требуется область чтения ресурса. Например, чтобы получать уведомления об изменениях в сообщениях, приложению необходимо разрешение Mail.Read. Уведомления об изменениях Outlook поддерживают области делегированных разрешений и разрешений приложений. Обратите внимание на указанные ниже ограничения.

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

• Чтобы подписаться на уведомления об изменениях контактов Outlook, событий или сообщений в общих или делегированных папках:

  • Используйте соответствующее разрешение приложения для подписки на изменения элементов в папке или почтовом ящике любого пользователя в клиенте.
  • Не используйте разрешения на общий доступ Outlook (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared и их коллеги на чтение и запись), так как они не поддерживают подписку на уведомления об изменении элементов в общих или делегированных папках.

presence

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

virtualEventWebinar

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

HTTP-запрос

POST /subscriptions

Заголовки запросов

Имя	Тип	Описание
Authorization	string	Bearer {token}. Обязательно.

Текст запроса

Предоставьте в тексте запроса описание объекта subscription в формате JSON.

Отклик

В случае успеха этот метод возвращает код отклика 201 Created и объект subscription в теле отклика. Подробнее о том, как возвращаются ошибки, см. в статье Возвращение ошибок.

Пример

Запрос

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

HTTP

POST https://graph.microsoft.com/v1.0/subscriptions
Content-type: application/json

{
   "changeType": "created",
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
   "resource": "me/mailFolders('Inbox')/messages",
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
   "clientState": "secretClientValue",
   "latestSupportedTlsVersion": "v1_2"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Subscription
{
	ChangeType = "created",
	NotificationUrl = "https://webhook.azurewebsites.net/api/send/myNotifyClient",
	Resource = "me/mailFolders('Inbox')/messages",
	ExpirationDateTime = DateTimeOffset.Parse("2016-11-20T18:23:45.9356913Z"),
	ClientState = "secretClientValue",
	LatestSupportedTlsVersion = "v1_2",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Subscriptions.PostAsync(requestBody);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc subscriptions create --body '{\
   "changeType": "created",\
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",\
   "resource": "me/mailFolders('Inbox')/messages",\
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",\
   "clientState": "secretClientValue",\
   "latestSupportedTlsVersion": "v1_2"\
}\
'

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

import (
	  "context"
	  "time"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewSubscription()
changeType := "created"
requestBody.SetChangeType(&changeType) 
notificationUrl := "https://webhook.azurewebsites.net/api/send/myNotifyClient"
requestBody.SetNotificationUrl(&notificationUrl) 
resource := "me/mailFolders('Inbox')/messages"
requestBody.SetResource(&resource) 
expirationDateTime , err := time.Parse(time.RFC3339, "2016-11-20T18:23:45.9356913Z")
requestBody.SetExpirationDateTime(&expirationDateTime) 
clientState := "secretClientValue"
requestBody.SetClientState(&clientState) 
latestSupportedTlsVersion := "v1_2"
requestBody.SetLatestSupportedTlsVersion(&latestSupportedTlsVersion) 

subscriptions, err := graphClient.Subscriptions().Post(context.Background(), requestBody, nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Subscription subscription = new Subscription();
subscription.setChangeType("created");
subscription.setNotificationUrl("https://webhook.azurewebsites.net/api/send/myNotifyClient");
subscription.setResource("me/mailFolders('Inbox')/messages");
OffsetDateTime expirationDateTime = OffsetDateTime.parse("2016-11-20T18:23:45.9356913Z");
subscription.setExpirationDateTime(expirationDateTime);
subscription.setClientState("secretClientValue");
subscription.setLatestSupportedTlsVersion("v1_2");
Subscription result = graphClient.subscriptions().post(subscription);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const subscription = {
   changeType: 'created',
   notificationUrl: 'https://webhook.azurewebsites.net/api/send/myNotifyClient',
   resource: 'me/mailFolders(\'Inbox\')/messages',
   expirationDateTime: '2016-11-20T18:23:45.9356913Z',
   clientState: 'secretClientValue',
   latestSupportedTlsVersion: 'v1_2'
};

await client.api('/subscriptions')
	.post(subscription);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Subscription;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Subscription();
$requestBody->setChangeType('created');
$requestBody->setNotificationUrl('https://webhook.azurewebsites.net/api/send/myNotifyClient');
$requestBody->setResource('me/mailFolders(\'Inbox\')/messages');
$requestBody->setExpirationDateTime(new \DateTime('2016-11-20T18:23:45.9356913Z'));
$requestBody->setClientState('secretClientValue');
$requestBody->setLatestSupportedTlsVersion('v1_2');

$result = $graphServiceClient->subscriptions()->post($requestBody)->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.ChangeNotifications

$params = @{
	changeType = "created"
	notificationUrl = "https://webhook.azurewebsites.net/api/send/myNotifyClient"
	resource = "me/mailFolders('Inbox')/messages"
	expirationDateTime = [System.DateTime]::Parse("2016-11-20T18:23:45.9356913Z")
	clientState = "secretClientValue"
	latestSupportedTlsVersion = "v1_2"
}

New-MgSubscription -BodyParameter $params

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.subscription import Subscription

graph_client = GraphServiceClient(credentials, scopes)

request_body = Subscription(
	change_type = "created",
	notification_url = "https://webhook.azurewebsites.net/api/send/myNotifyClient",
	resource = "me/mailFolders('Inbox')/messages",
	expiration_date_time = "2016-11-20T18:23:45.9356913Z",
	client_state = "secretClientValue",
	latest_supported_tls_version = "v1_2",
)

result = await graph_client.subscriptions.post(request_body)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Предоставьте в тексте запроса описание объекта subscription в формате JSON. Поля clientState и latestSupportedTlsVersion необязательны.

Поведение повторяющихся подписок

Дублирование подписок запрещено. Если запрос подписки содержит те же значения для changeType и ресурса , что и в существующей подписке, запрос завершается ошибкой с кодом 409 ConflictHTTP и сообщением Subscription Id <> already exists for the requested combinationоб ошибке .

Примеры ресурсов

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

Тип ресурса	Примеры
Записи звонков	communications/callRecords
callRecording	communications/onlineMeetings/getAllRecordings, communications/onlineMeetings/{onlineMeetingId}/recordings, users/{userId}/onlineMeetings/getAllRecordings
callTranscript	communications/onlineMeetings/getAllTranscripts, communications/onlineMeetings/{onlineMeetingId}/transcripts, users/{userId}/onlineMeetings/getAllTranscripts
Сообщение чата	chats/{id}/messages, chats/getAllMessages, teams/{id}/channels/{id}/messages, teams/getAllMessages
Контакты	me/contacts
Беседы	groups('{id}')/conversations
Диски	me/drive/root
События	me/events
Группы	groups
Список	sites/{site-id}/lists/{list-id}
Почта	me/mailfolders('inbox')/messages, me/messages
Присутствие	/communications/presences/{id} (один пользователь), /communications/presences?$filter=id in ('{id}','{id}',…) (несколько пользователей)
printer	print/printers/{id}/jobs
PrintTaskDefinition	print/taskDefinitions/{id}/tasks
Оповещение безопасности	security/alerts?$filter=status eq 'New'
todoTask	/me/todo/lists/{todoTaskListId}/tasks
Пользователи	users

Примечание. Любой путь, начинающийся с me, также можно использовать с users/{id} вместо me, чтобы указать определенного пользователя, а не текущего пользователя.

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions/$entity",
  "id": "7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
  "resource": "me/mailFolders('Inbox')/messages",
  "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
  "changeType": "created",
  "clientState": "secretClientValue",
  "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
  "expirationDateTime": "2016-11-20T18:23:45.9356913Z",
  "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
  "latestSupportedTlsVersion": "v1_2",
  "notificationContentType": "application/json"
}

Проверка конечной точки уведомлений

Конечная точка уведомления подписки (указанная в свойстве notificationUrl) должна поддерживать ответ на запрос проверки, как описано в статье Настройка уведомлений об изменениях в пользовательских данных. Если проверка завершилась сбоем, запрос на создание подписки возвращает ошибку 400 (неверный запрос).