contact: delta

  • 项目

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

获取指定文件夹中已添加、删除或更新的联系人集。

针对文件夹中的联系人的 delta 函数调用类似于 GET 请求，不同之处在于，通过在一个或多个调用中适当应用 状态令牌 ，可以查询该文件夹中联系人的增量更改。 这样，就可以维护和同步用户联系人的本地存储，而无需每次都从服务器提取整个联系人集。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） Contacts.Read Contacts.ReadWrite
委派（个人 Microsoft 帐户） Contacts.Read Contacts.ReadWrite
应用程序 Contacts.Read Contacts.ReadWrite

HTTP 请求

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

查询参数

跟踪联系人中的更改会导致一轮或多次 delta 函数调用。 如果要使用任意查询参数（$deltatoken 和 $skiptoken 除外），则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将指定的任意参数编码为响应中提供的 @odata.nextLink 或 @odata.deltaLink URL 的令牌部分。 只需预先指定所需的任何查询参数一次。 在后续请求中，只需复制并应用 @odata.nextLink 上一响应中的 或 @odata.deltaLink URL，因为该 URL 已包含编码的所需参数。

查询参数 类型 说明
$deltatoken 字符串 在上一个 delta 函数的 URL 中@odata.deltaLink返回的状态令牌调用同一联系人集合，指示完成这一轮更改跟踪。 将此令牌包含在对该集合的下一组更改追踪的首次请求中，并保存和应用整个 @odata.deltaLink URL。
$skiptoken string 之前的 delta 函数调用的 @odata.nextLink URL 中返回的状态令牌，指示同一个联系人集合中有进一步的更改需要跟踪。

OData 查询参数

  • 像在任何 GET 请求中一样，你可以使用 $select 查询参数以仅指定获取最佳性能所需的属性。 始终返回 id 属性。

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。
Content-Type string application/json. 必需。
Prefer string odata.maxpagesize={x}。 可选。

响应

如果成功，此方法在响应正文中返回 200 OK 响应代码和 contact 集合对象。

示例

请求

下面的示例演示了如何调用单个 delta 函数，使用 $select 参数仅获取每个联系人的 displayName 属性并将响应正文中的联系人的最大数目限制为 2。

若要跟踪文件夹中联系人的更改，要使用正确的状态令牌执行一次或多次 delta 函数调用来获取上次增量查询后的增量更改集。

可以找到一个类似的示例，该示例演示如何使用状态令牌跟踪邮件文件夹中的邮件中的更改： 获取对文件夹中邮件的增量更改。 跟踪联系人和文件夹中跟踪邮件之间的main差异位于增量查询请求 URL 中，以及返回联系人而不是邮件集合的查询响应中。

GET https://graph.microsoft.com/beta/me/contactFolders/{id}/contacts/delta?$select=displayName

Prefer: odata.maxpagesize=2
响应

如果请求成功，响应将包含一个状态令牌，其为 skipToken
(@odata.nextLink 响应标头) 或 @odata.deltaLink 响应标头) 中的 deltaToken (。 它们分别指示是应继续执行回合，还是已完成获取该回合的所有更改。

以下响应显示了 @odata.nextLink 响应头中的 skipToken。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/contactfolders/{id}/contacts/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "parentFolderId": "parentFolderId-value",
      "birthday": "2016-10-19T10:37:00Z",
      "fileAs": "fileAs-value",
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "initials": "initials-value"
    }
  ]
}

相关内容