Compartir a través de

contactFolder: delta

  • Artículo

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.

Obtenga un conjunto de carpetas de contactos que se hayan agregado, eliminado o quitado del buzón del usuario.

Una llamada de función delta para las carpetas de contactos de un buzón es similar a una solicitud GET, salvo que al aplicar correctamente tokens de estado en una o varias de estas llamadas, puede consultar los cambios incrementales en las carpetas de contactos. Esto le permite mantener y sincronizar un almacén local de las carpetas de contactos de un usuario sin tener que capturar todas las carpetas de contactos de ese buzón del servidor cada vez.

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

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Contacts.Read Contacts.ReadWrite
Delegado (cuenta personal de Microsoft) Contacts.Read Contacts.ReadWrite
Aplicación Contacts.Read Contacts.ReadWrite

Solicitud HTTP

GET /me/contactFolders/delta
GET /users/{id}/contactFolders/delta

Parámetros de consulta

El seguimiento de los cambios en las carpetas de contactos genera una ronda de una o varias llamadas de función delta . Si usa cualquier parámetro de consulta (distinto de $deltatoken y $skiptoken), debe especificarlo en la solicitud delta inicial. Microsoft Graph codifica automáticamente los parámetros especificados en la parte del token (skiptoken o $deltatoken) de la @odata.nextLink dirección URL o @odata.deltaLink proporcionada en la respuesta. Solo debe especificar una vez por adelantado los parámetros de consulta deseados. En solicitudes posteriores, simplemente copie y aplique la @odata.nextLink dirección URL o @odata.deltaLink de la respuesta anterior, ya que esa dirección URL ya incluye los parámetros codificados y deseados.

Parámetro de consulta Tipo Descripción
$deltatoken string Un token de estado devuelto en la @odata.deltaLink dirección URL de la llamada de función delta anterior para la misma colección de carpetas de contactos, que indica la finalización de esa ronda de seguimiento de cambios. Guarde y aplique toda la dirección URL @odata.deltaLink, incluido este token, en la primera solicitud de la siguiente ronda de seguimiento de cambios de la colección.
$skiptoken string Token de estado que se devuelve en la dirección URL de @odata.nextLink de la llamada de función delta. Indica que debe realizarse el seguimiento de más cambios en la misma colección de carpetas de correo.

Parámetros de consulta de OData

Puede utilizar un parámetro de consulta $select como en cualquier solicitud GET para especificar solo las propiedades que necesita para un mejor rendimiento. Siempre se devuelve la propiedad id.

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.
Content-Type string application/json. Necesario.
Prefer string odata.maxpagesize={x}. Opcional.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto de colección contactFolder en el cuerpo de la respuesta.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra cómo realizar una llamada de función delta única y limitar el número máximo de carpetas de contactos en el cuerpo de la respuesta a 2.

Para realizar un seguimiento de los cambios de las carpetas de contactos de un buzón, debería realizar al menos una llamada de función delta, con unos tokens de estado adecuados, para obtener el conjunto de cambios incrementales desde la última consulta delta.

Puede encontrar un ejemplo similar que muestra cómo usar los tokens de estado para realizar un seguimiento de los cambios en los mensajes de una carpeta de correo: Obtener cambios incrementales en los mensajes de una carpeta. Las principales diferencias entre el seguimiento de carpetas de contactos y los mensajes de seguimiento de una carpeta se encuentran en las direcciones URL de solicitud de consulta delta y las respuestas de consulta que devuelven contactFolder en lugar de colecciones de mensajes .

GET https://graph.microsoft.com/beta/me/contactFolders/delta

Prefer: odata.maxpagesize=2
Respuesta

Si la solicitud es correcta, la respuesta debería incluir un símbolo de estado, que puede ser un skipToken
(en un encabezado de respuesta @odata.nextLink ) o deltaToken (en un encabezado de respuesta @odata.deltaLink ). Respectivamente, indican si debe continuar con la ronda o si ha completado la obtención de todos los cambios para esa ronda.

La respuesta siguiente muestra un skipToken en un encabezado de respuesta de @odata.nextLink.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/contactfolders/delta?$skiptoken={_skipToken_}",
  "value": [
    {
     "parentFolderId": "parentFolderId-value",
      "displayName": "displayName-value",
      "wellKnownName": "wellKnownName-value",
      "id": "id-value"
    }
  ]
}

Contenido relacionado