Crear suscripción

Espacio de nombres: microsoft.graph

Suscribe una aplicación de escucha para que reciba notificaciones de cambio cuando se realiza el tipo de cambios solicitado en el recurso especificado de Microsoft Graph.

Para identificar los recursos para los que puede crear suscripciones y las limitaciones de las suscripciones, consulte Configurar notificaciones para cambios en los datos de recursos: Recursos admitidos.

Algunos recursos admiten notificaciones enriquecidas, es decir, notificaciones que incluyen datos de recursos. Para obtener más información sobre estos recursos, consulte Configuración de notificaciones de cambios que incluyan datos de recursos: Recursos compatibles.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Permissions

La creación de una suscripción requiere permiso de lectura para el recurso. Por ejemplo, para obtener notificaciones de cambios en los mensajes, la aplicación necesita los permisos Mail.Read.

Según el recurso y el tipo de permisos (delegado o de aplicación) solicitado, el permiso especificado en la tabla siguiente es el menos privilegiado necesario para llamar a esta API. Para obtener más información, incluidas las precauciones antes de elegir los permisos, busque los siguientes permisos en Permisos.

chatMessage

Se puede especificar que las suscripciones a chatMessage incluyan datos de recursos (includeResourceData establecido en true). En ese caso, se requiere cifrado y se produce un error en la creación de la suscripción si no se especifica un encryptionCertificate para dichas suscripciones.

Use el encabezado de Prefer: include-unknown-enum-members solicitud para obtener los siguientes valores en chatMessagemessageTypeevolvable enum:systemEventMessage for /teams/{id}/channels/{id}/messages y /chats/{id}/messages resource.

conversationMember

Las suscripciones conversationMember se pueden especificar para incluir datos de recursos (includeResourceData establecido en true). En ese caso, se requiere cifrado y se produce un error en la creación de la suscripción si no se especifica un encryptionCertificate para dichas suscripciones.

Equipo, canal y chat

Se pueden especificar suscripciones de equipo, canal y chat para incluir datos de recursos (includeResourceData establecido en true). En ese caso, se requiere cifrado y se produce un error en la creación de la suscripción si no se especifica un encryptionCertificate para dichas suscripciones.

Puede usar el parámetro de cadena de consulta notifyOnUserSpecificProperties al suscribirse a cambios en un chat determinado o en el nivel de usuario. Al establecer el parámetro de cadena de consulta notifyOnUserSpecificProperties durante true la creación de la suscripción, se envían dos tipos de cargas al suscriptor. Un tipo contiene propiedades específicas del usuario y el otro se envía sin ellas. Para obtener más información, consulte Obtener notificaciones de cambios para chats con Microsoft Graph.

aiInsights

Las suscripciones a Copilot AI Insights requieren una licencia válida de Copilot que incluya el siguiente plan de servicio de Copilot:

• Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

aiInteracción

Las suscripciones en interacciones de IA de Copilot requieren una licencia válida de Copilot que incluya el siguiente plan de servicio de Copilot:

• Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

En el caso de las suscripciones que se centran en las interacciones de IA de Copilot de las que forma parte un usuario determinado, el usuario de la ruta de acceso del recurso debe tener asignados los planes de servicio anteriores en un estado válido.

En el caso de las suscripciones que se dirigen a las interacciones de IA de Copilot para todo el inquilino, el inquilino debe tener licencias válidas aprovisionadas que incluyan todos los planes de servicio anteriores de Copilot.

driveItem

Se aplican más limitaciones a las suscripciones de elementos de OneDrive. Estas limitaciones se aplican para crear y administrar (obtener, actualizar y eliminar) las suscripciones.

En OneDrive personal, puede suscribirse a la carpeta raíz o a cualquier subcarpeta de la unidad. En OneDrive para el trabajo o la escuela, solo puede suscribirse a la carpeta raíz. Se envían notificaciones de cambios para los cambios solicitados en la carpeta suscrita o en cualquier archivo, carpeta u otras instancias de driveItem en su jerarquía. No puede suscribirse a instancias de unidad o elemento de unidad que no sean carpetas, como archivos individuales.

OneDrive para el trabajo o la escuela y soporte técnico de SharePoint enviando a su aplicación notificaciones de eventos de seguridad que se producen en un elemento de unidad. Para suscribirse a estos eventos, agregue el prefer:includesecuritywebhooks de usuario a su solicitud para crear una suscripción. Una vez creada la suscripción, recibirá notificaciones cuando cambien los permisos de un elemento. Este encabezado se aplica a SharePoint y OneDrive profesional o educativo, pero no a las cuentas de OneDrive de consumidor.

contactos, eventos y mensajes

Puede suscribirse a los cambios en los recursos de contactos, eventos o mensajes de Outlook y, opcionalmente, especificar en la carga de solicitud POST si se incluirán datos de recursos cifrados en las notificaciones.

Crear y administrar (obtener, actualizar y eliminar) una suscripción requiere un ámbito de lectura para el recurso. Por ejemplo, para obtener notificaciones de cambio de mensajes, la aplicación necesita el permiso Mail.Read. Las notificaciones de cambio de Outlook admiten ámbitos de permisos delegados y de aplicación. Tenga en cuenta las siguientes limitaciones:

• El permiso delegado es compatible con la suscripción a los elementos en las carpetas que se encuentran solo en el buzón del usuario que ha iniciado sesión. Por ejemplo, no puede usar el permiso delegado Calendars.Read para suscribirse a eventos del buzón de otro usuario.

• Para suscribirse y cambiar las notificaciones de eventos, contactos o mensajes de Outlook en carpetas compartidas o delegadas:

  • Use los permisos de aplicación correspondientes para suscribirse a los cambios de los elementos de una carpeta o un buzón de cualquier usuario del espacio empresarial.
  • No use los permisos de uso compartido de Outlook (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared y sus homólogos de lectura y escritura), ya que no admiten la suscripción para cambiar las notificaciones de los elementos de las carpetas compartidas o delegadas.

onlineMeetings, presence

Las suscripciones en onlineMeetings y presence requieren la propiedad encryptionCertificate y encryptionCertificateId al crear una suscripción para notificaciones con datos de recursos cifrados. Para obtener más información, consulte la configuración de notificaciones de cambios para incluir datos de recursos. Para obtener más información sobre las suscripciones a reuniones en línea, consulte Obtener notificaciones de cambios para reuniones en línea.

virtualEventWebinar y virtualEventTownhall

Las suscripciones a eventos virtuales solo admiten notificaciones básicas y se limitan a unas pocas entidades de un evento virtual. Para obtener más información sobre los tipos de suscripción admitidos, consulte Obtener notificaciones de cambios para las actualizaciones de eventos virtuales de Microsoft Teams.

Solicitud HTTP

POST /subscriptions

Encabezados de solicitud

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto de suscripción.

Respuesta

Si se realiza correctamente, este método devuelve un código de 201 Created respuesta y un objeto de suscripción en el cuerpo de la respuesta.

Vea Respuestas de error para obtener detalles sobre la manera en que se devuelven los errores.

Ejemplo

Solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto subscription. Los campos clientState y latestSupportedTlsVersion son opcionales.

Esta solicitud crea una suscripción para las notificaciones de cambios sobre el nuevo correo que recibe el usuario que ha iniciado sesión actualmente.

POST https://graph.microsoft.com/beta/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"
}

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

// Dependencies
using Microsoft.Graph.Beta.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);

// Code snippets are only available for the latest major version. Current major version is $v0.*

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

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) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
subscriptions, err := graphClient.Subscriptions().Post(context.Background(), requestBody, nil)

// 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);

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')
	.version('beta')
	.post(subscription);

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\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();

Import-Module Microsoft.Graph.Beta.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-MgBetaSubscription -BodyParameter $params

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.subscription import Subscription
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
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)

En el cuerpo de la solicitud, proporcione una representación JSON del objeto subscription. Los campos clientState y latestSupportedTlsVersion son opcionales.

Comportamiento de suscripción duplicado

No se permiten suscripciones duplicadas. Cuando una solicitud de suscripción contiene los mismos valores para changeType y resource que contiene una suscripción existente, se produce un error en la solicitud con un código 409 Conflictde error HTTP y el mensaje Subscription Id <> already exists for the requested combinationde error.

Ejemplos de recursos

Los siguientes son valores válidos para la propiedad de recurso.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$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"
}

Ejemplo 2: Crear una suscripción destinada a un punto de conexión de inserción web

En el ejemplo siguiente se crea una suscripción que entrega notificaciones de cambios cifradas a un punto de conexión de inserción web nativo del explorador (como web.push.apple.com, fcm.googleapis.com, o updates.push.services.mozilla.com).

Antes de crear esta suscripción, la aplicación basada en explorador debe:

1. Llame a la función getVapidPublicKey de la colección de suscripciones para obtener la clave pública VAPID de Microsoft Graph (RFC 8292).
2. Llame PushManager.subscribe({ applicationServerKey: <vapidPublicKey> }) para registrarse con el servicio push del explorador. El explorador devuelve un PushSubscription , , y auth valores que contienenendpointp256dh.

Después, la aplicación crea la suscripción con notificationUrl establecido en la dirección URL del punto de conexión de servicio de inserción desnuda y las propiedades vapidPublicKey, webPushEncryptionP256dhPublicKey y webPushEncryptionSecret establecidas en los valores devueltos por el explorador. Después de la creación, Microsoft Graph cifra cada notificación por RFC 8291 con las claves almacenadas y firma la solicitud con VAPID antes de publicarla en el servicio de inserción.

Solicitud

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

{
  "changeType": "created,updated",
  "notificationUrl": "https://web.push.apple.com/QKmFUwSBFK8g7iY4t1...",
  "resource": "me/mailFolders('Inbox')/messages",
  "expirationDateTime": "2026-12-31T11:00:00.0000000Z",
  "clientState": "secretClientValue",
  "vapidPublicKey": "BNKm...base64url-encoded-server-vapid-public-key...",
  "webPushEncryptionP256dhPublicKey": "BNcR...base64url-encoded-client-public-key...",
  "webPushEncryptionSecret": "tBHI...base64url-encoded-auth-secret..."
}

Nota: La propiedad webPushEncryptionSecret es de solo escritura. Nunca se devuelve en GET las respuestas (devuelto como null). Trate el valor como un secreto.

Validación de extremo de notificación

El punto de conexión de notificación de suscripción (especificado en la propiedad notificationUrl ) debe ser capaz de responder a una solicitud de validación, tal como se describe en Configurar notificaciones para cambios en los datos de usuario. Si se produce un error de validación, la solicitud para crear la suscripción devuelve un error 400 de solicitud incorrecta.