列出联系人

从已登录用户的默认联系人文件夹中获取联系人集合。

权限

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

权限类型 权限(从最低特权到最高特权)
委派(工作或学校帐户) Contacts.Read、Contacts.ReadWrite
委派(个人 Microsoft 帐户) Contacts.Read、Contacts.ReadWrite
应用程序 Contacts.Read、Contacts.ReadWrite

HTTP 请求

若要获取用户邮箱中的所有联系人,请执行以下操作:

GET /me/contacts
GET /users/{id | userPrincipalName}/contacts

若要获取用户邮箱中特定文件夹中的联系人,请执行以下操作:

GET /me/contactfolders/{Id}/contacts
GET /users/{id | userPrincipalName}/contactfolders/{id}/contacts

GET /me/contactFolder/{id}/childFolders/{id}/.../contacts
GET /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts

可选的查询参数

此方法支持 OData 查询参数 来帮助自定义响应。

例如,你可以使用 $filter 查询参数根据联系人的电子邮件地址的域来过滤联系人:

https://graph.microsoft.com/v1.0/me/contacts?$filter=emailAddresses/any(a:a/address eq '@domain.com')

请求标头

标头
Authorization Bearer {token}。必需。
Content-Type application/json

请求正文

请勿提供此方法的请求正文。

响应

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

示例

请求

下面是一个请求示例。

GET https://graph.microsoft.com/v1.0/me/contacts
响应

下面是一个响应示例。注意:为了简单起见,可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。

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

{
  "value": [
    {
      "parentFolderId": "parentFolderId-value",
      "birthday": "datetime-value",
      "fileAs": "fileAs-value",
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "initials": "initials-value"
    }
  ]
}