Compartir a través de


Crear suscripción

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

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 Configuración de 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, vea Configurar notificaciones de cambios que incluyen datos de recursos: recursos admitidos.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

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.

Nota:

  • Debido a las restricciones de seguridad, las suscripciones de Microsoft Graph no admiten permisos de acceso de escritura cuando solo se necesitan permisos de acceso de lectura.
  • Algunos recursos admiten notificaciones de cambio en varios escenarios, cada uno de los cuales puede requerir permisos diferentes. En esos casos, use la ruta de acceso del recurso para diferenciar los escenarios.
Recurso admitido Delegado (cuenta profesional o educativa) Delegado (cuenta de Microsoft personal) Aplicación
callRecord No admitida. No admitida. CallRecords.Read.All
callRecording
communications/onlineMeetings/getAllRecordings
Cualquier grabación estará disponible en el inquilino.
No admitida. No admitida. OnlineMeetingRecording.Read.All
callRecording
communications/onlineMeetings/{onlineMeetingId}/recordings
Cualquier grabación estará disponible para una reunión específica.
OnlineMeetingRecording.Read.All No admitida. OnlineMeetingRecording.Read.All
callRecording
users/{userId}/onlineMeetings/getAllRecordings
Grabación de llamadas que está disponible en una reunión organizada por un usuario específico.
OnlineMeetingRecording.Read.All No admitida. OnlineMeetingRecording.Read.All
callRecording
appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings
Grabación de llamadas que está disponible en una reunión en la que se instala una aplicación de Teams determinada.
No admitida. No admitida. OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat
callTranscript
communications/onlineMeetings/getAllTranscripts
Cualquier transcripción estará disponible en el inquilino.
No admitida. No admitida. OnlineMeetingTranscript.Read.All
callTranscript
communications/onlineMeetings/{onlineMeetingId}/transcripts
Cualquier transcripción estará disponible para una reunión específica.
OnlineMeetingTranscript.Read.All No admitida. OnlineMeetingTranscript.Read.All
callTranscript
users/{userId}/onlineMeetings/getAllTranscripts
Transcripción de llamadas que está disponible en una reunión organizada por un usuario específico.
OnlineMeetingTranscript.Read.All No admitida. OnlineMeetingTranscript.Read.All
callTranscript
appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts
Transcripción de llamadas que está disponible en una reunión en la que se instala una aplicación de Teams determinada.
No admitida. No admitida. OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat
channel
/teams/getAllChannels
Todos los canales de una organización.
No admitida. No admitida. Channel.ReadBasic.All, ChannelSettings.Read.All
channel
/teams/{id}/channels
Todos los canales de un equipo determinado de una organización.
Channel.ReadBasic.All, ChannelSettings.Read.All No admitida. Channel.ReadBasic.All, ChannelSettings.Read.All
chat
/chats
Todos los chats de una organización.
No admitida. No admitida. Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat
/chats/{id}
Un chat en particular.
Chat.ReadBasic, Chat.Read, Chat.ReadWrite No admitida. ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat
/appCatalogs/teamsApps/{id}/installedToChats
Todos los chats de una organización donde está instalada una aplicación de Teams determinada.
No admitida. No admitida. Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chat
/users/{id}/chats
Todos los chats de los que forma parte un usuario determinado.
Chat.ReadBasic, Chat.Read, Chat.ReadWrite No admitida. Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chatMessage
/teams/{id}/channels/{id}/messages
Todos los mensajes y respuestas de un canal determinado.
ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All No admitida. ChannelMessage.Read.Group, ChannelMessage.Read.All
chatMessage
/teams/getAllMessages
Todos los mensajes de canal de la organización.
No admitida. No admitida. ChannelMessage.Read.All
chatMessage
/chats/{id}/messages
Todos los mensajes de un chat.
Chat.Read, Chat.ReadWrite No admitida. Chat.Read.All
chatMessage
/chats/getAllMessages
Todos los mensajes de chat de una organización.
No admitida. No admitida. Chat.Read.All
chatMessage
/users/{id}/chats/getAllMessages
Mensajes de chat para todos los chats de los que forma parte un usuario determinado.
Chat.Read, Chat.ReadWrite No admitida. Chat.Read.All, Chat.ReadWrite.All
chatMessage
/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages
Mensajes de chat para todos los chats de una organización donde está instalada una aplicación de Teams determinada.
No admitida. No admitida. Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact Contacts.Read Contacts.Read Contacts.Read
conversationMember
/chats/getAllMembers
Miembros de todos los chats de una organización.
No admitida. No admitida. ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All.
conversationMember
/chats/{id}/members
Miembros de un chat determinado.
ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite No admitida. 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
Miembros de chat para todos los chats de una organización en la que está instalada una aplicación de Teams determinada.
No admitida. No admitida. ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember
/teams/getAllMembers
Miembros de todos los equipos de una organización.
No admitida. No admitida. TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember
/teams/{id}/members
Miembros de un equipo determinado.
TeamMember.Read.All No admitida. TeamMember.Read.All
conversationMember
/teams/{id}/channels/getAllMembers
Miembros de todos los canales privados de un equipo determinado.
No admitida. No admitida. ChannelMember.Read.All
conversationMember
/teams/getAllChannels/getAllMembers
No admitida. No admitida. ChannelMember.Read.All
driveItem (OneDrive personal del usuario) No admitida. Files.ReadWrite No admitida.
driveItem (OneDrive para la Empresa) Files.ReadWrite.All No admitida. Files.ReadWrite.All
evento Calendars.Read Calendars.Read Calendars.Read
grupo Group.Read.All No admitida. Group.Read.All
conversación de grupo Group.Read.All No admitida. No admitida.
lista Sites.ReadWrite.All No admitida. Sites.ReadWrite.All
message Mail.ReadBasic, Mail.Read Mail.ReadBasic, Mail.Read Mail.Read
offerShiftRequest
/teams/{id}/schedule/offerShiftRequests
Cambios en cualquier solicitud de turno de oferta en un equipo.
Schedule.Read.All, Schedule.ReadWrite.All No admitida. Schedule.Read.All, Schedule.ReadWrite.All
onlineMeeting No admitida. No admitida. OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All*
openShiftChangeRequest
/teams/{id}/schedule/openShiftChangeRequests
Cambios en cualquier solicitud de turno abierta en un equipo.
Schedule.Read.All, Schedule.ReadWrite.All No admitida. Schedule.Read.All, Schedule.ReadWrite.All
presencia Presence.Read.All No admitida. No admitida.
printer No admitida. No admitida. Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition No admitida. No admitida. PrintTaskDefinition.ReadWrite.All
alerta de seguridad SecurityEvents.ReadWrite.All No admitida. SecurityEvents.ReadWrite.All
shift
/teams/{id}/schedule/shifts
Cambios en cualquier turno de un equipo.
Schedule.Read.All, Schedule.ReadWrite.All No admitida. Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest
/teams/{id}/schedule/swapShiftsChangeRequests
Cambios en cualquier solicitud de cambio de turno en un equipo.
Schedule.Read.All, Schedule.ReadWrite.All No admitida. Schedule.Read.All, Schedule.ReadWrite.All
team
/teams
Todos los equipos de una organización.
No admitida. No admitida. Team.ReadBasic.All, TeamSettings.Read.All
team
/teams/{id}
Un equipo determinado.
Team.ReadBasic.All, TeamSettings.Read.All No admitida. Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest
/teams/{id}/schedule/timeOffRequests
Cambios en cualquier solicitud de tiempo de descuento en un equipo.
Schedule.Read.All, Schedule.ReadWrite.All No admitida. Schedule.Read.All, Schedule.ReadWrite.All
todoTask Tasks.ReadWrite Tasks.ReadWrite No admitida.
user User.Read.All User.Read.All User.Read.All
virtualEventWebinar VirtualEvent.Read No admitida. VirtualEvent.Read.All
baseTask (en desuso) Tasks.ReadWrite Tasks.ReadWrite No admitida.

Nota:

Los permisos siguientes usan el consentimiento específico del recurso:

  • OnlineMeetingRecording.Read.Chat
  • OnlineMeetingTranscript.Read.Chat
  • ChatSettings.Read.Chat
  • ChatSettings.ReadWrite.Chat
  • Chat.Manage.Chat
  • ChannelMessage.Read.Group
  • ChatMember.Read.Chat

chatMessage

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

Debe usar el encabezado de Prefer: include-unknown-enum-members solicitud para obtener los siguientes valores en la enumeración evolvablechatMessagemessageType: systemEventMessage for /teams/{id}/channels/{id}/messages y /chats/{id}/messages resource.

Nota:

/teams/getAllMessages, /chats/getAllMessages, /me/chats/getAllMessages, /users/{id}/chats/getAllMessagesy /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages son API de uso medido; se pueden aplicar modelos de pago y requisitos de licencia . /teams/getAllMessagesy /chats/getAllMessages admiten tanto los modelos de model=Bmodel=A pago como , /me/chats/getAllMessages/users/{id}/chats/getAllMessagesy /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages solo model=Badmiten . Si no especifica un modelo de pago en la consulta, se usará el modo de evaluación predeterminado.

Nota:

Para agregar o cambiar un modelo de pago para un recurso suscrito de una notificación de cambio, debe crear una nueva suscripción de notificación de cambio con el nuevo modelo de pago; Actualizar una notificación de cambio existente no funciona.

conversationMember

las suscripciones conversationMember se pueden especificar para incluir datos de recursos. Si se especifica para incluir datos de recursos (includeResourceData establecido en true), se requiere cifrado. Se produce un error en la creación de la suscripción si no se especifica un encryptionCertificate.

Nota:

/teams/getAllMembers, /chats/getAllMembersy /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers son API de uso medido; se pueden aplicar modelos de pago y requisitos de licencia . /teams/getAllMembers y /chats/getAllMembers admiten los modelos de model=A pago y model=B . /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers solo model=Badmite . Si no especifica un modelo de pago en la consulta, se usará el modo de evaluación predeterminado.

Nota:

Para agregar o cambiar un modelo de pago para un recurso suscrito de una notificación de cambio, debe crear una nueva suscripción de notificación de cambio con el nuevo modelo de pago; Actualizar una notificación de cambio existente no funciona.

equipo, canal y chat

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

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 notifyOnUserSpecificPropertiestrue en durante 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 Obtención de notificaciones de cambios para chats con Microsoft Graph.

Nota:

/appCatalogs/teamsApps/{id}/installedToChats tiene requisitos de concesión de licencias y pagos, que solo admiten específicamente model=B. Si no se especifica ningún modelo, se usará el modo de evaluación.

Nota:

Para agregar o cambiar un modelo de pago para un recurso suscrito de una notificación de cambio, debe crear una nueva suscripción de notificación de cambio con el nuevo modelo de pago; Actualizar una notificación de cambio existente no funciona.

Ejemplo de solicitud

Especifique el parámetro de consulta model en la propiedad del recurso en el cuerpo de la solicitud.

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

Se aplican más limitaciones a las suscripciones en 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 la Empresa, puede suscribirse solo a la carpeta raíz. Las notificaciones de cambio se envían para los cambios solicitados en la carpeta suscrita o en cualquier archivo, carpeta u otras instancias de driveItem de su jerarquía. No puede suscribirse a instancias de drive o driveItem que no sean carpetas, como archivos individuales.

Soporte técnico de OneDrive para la Empresa y SharePoint para enviar notificaciones de aplicación de eventos de seguridad que se producen en un driveItem. 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 para la Empresa, pero no a las cuentas de OneDrive de consumidor.

contactos, eventos y mensajes

Puede suscribirse a los cambios en los recursos de contacto, evento o mensaje de Outlook y, opcionalmente, especificar en la carga de la solicitud POST si se deben incluir 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 en el 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 a notificaciones de cambios en elementos de carpetas compartidas o delegadas.

onlineMeetings, presencia

Las suscripciones en onlineMeetings y la presencia requieren la propiedad encryptionCertificate y encryptionCertificateId al crear una suscripción para las notificaciones con datos de recursos cifrados. Para obtener más información, consulte 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 Obtención de notificaciones de cambios para reuniones en línea.

virtualEventWebinar

Las suscripciones en eventos virtuales solo admiten notificaciones básicas y están limitadas a algunas entidades de un evento virtual. Para obtener más información sobre los tipos de suscripción admitidos, consulte Obtención de notificaciones de cambios para las actualizaciones de eventos virtuales de Microsoft Teams.

Solicitud HTTP

POST /subscriptions

Encabezados de solicitud

Nombre Tipo Descripción
Authorization string {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

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

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de 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 notificaciones de cambio sobre el nuevo correo recibido por 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"
}

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 duplicada

No se permiten suscripciones duplicadas. Cuando una solicitud de suscripción contiene los mismos valores para changeType y el recurso 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.

Tipo de recurso Ejemplos
callRecord communications/callRecords
callRecording communications/onlineMeetings/getAllRecordings, communications/onlineMeetings/{onlineMeetingId}/recordings, users/{userId}/onlineMeetings/getAllRecordings, appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings
callTranscript communications/onlineMeetings/getAllTranscripts, communications/onlineMeetings/{onlineMeetingId}/transcripts, users/{userId}/onlineMeetings/getAllTranscripts, appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts
channel /teams/getAllChannels, /teams/{id}/channels
chat /chats, /chats/{id}
chatMessage chats/{id}/messages, chats/getAllMessages, teams/{id}/channels/{id}/messages, teams/getAllMessages
contact me/contacts
conversationMember /chats/{id}/members, /chats/getAllMembers, /teams/{id}/members, /teams/getAllMembers, /teams/{id}/channels/getAllMembers
driveItem me/drive/root
evento me/events
grupo groups
conversación de grupo groups('{id}')/conversations
list sites/{site-id}/lists/{list-id}
message me/mailfolders('inbox')/messages, me/messages
onlineMeeting /communications/onlineMeetings/?$filter=JoinWebUrl eq '{JoinWebUrl}'
presencia /communications/presences/{id} (usuario único), /communications/presences?$filter=id in ('{id}','{id}',…) (varios usuarios)
printer print/printers/{id}/jobs
printTaskDefinition print/taskDefinitions/{id}/tasks
team /teams, /teams/{id}
user users
todoTask /me/todo/lists/{todoTaskListId}/tasks
alerta de seguridad security/alerts?$filter=status eq 'NewAlert'
baseTask (en desuso) /me/tasks/lists/{Id}/tasks

Nota:

Cualquier ruta de acceso que comience por me también se puede usar con users/{id} en lugar de me para dirigirse a un usuario específico en lugar del usuario actual.

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"
}

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 como se describe en Configuración de 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.