获取联系人
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
检索联系人对象的属性和关系。
在两种情况下,应用可以在其他用户的联系人文件夹中获取联系人:
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | Contacts.Read | Contacts.ReadWrite |
委派(个人 Microsoft 帐户) | Contacts.Read | Contacts.ReadWrite |
应用程序 | Contacts.Read | Contacts.ReadWrite |
HTTP 请求
用户邮箱中的 联系人 。
GET /me/contacts/{id}
GET /users/{id | userPrincipalName}/contacts/{id}
用户顶级contactFolder 中的联系人。
GET /me/contactfolders/{Id}/contacts/{id}
GET /users/{id | userPrincipalName}/contactfolders/{id}/contacts/{id}
contactFolder 的子文件夹中包含的 联系人。 下面的示例显示了一个嵌套级别,但联系人可能位于子级的子级中,诸如此类。
GET /me/contactFolders/{id}/childFolders/{id}/.../contacts/{id}
GET /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}
可选的查询参数
Name | 值 | 说明 |
---|---|---|
$expand | string | 要在响应中扩展和添加的关系(以逗号分隔的列表)。 有关支持的名称,请参阅 contact 对象的 relationships 表。 |
$select | string | 要在响应中包括的属性的列表(以逗号分隔)。 |
请求标头
标头 | 值 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回 200 OK
响应代码和 contact 对象。
示例
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/me/contacts/AAMkAGI2THk0AAA=
响应
以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkAGI2THk0AAA=",
"createdDateTime": "2014-10-19T23:08:24Z",
"lastModifiedDateTime": "2014-10-19T23:08:24Z",
"changeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4",
"categories": [],
"parentFolderId": "AAMkAGI2AAEOAAA=",
"birthday": "1974-07-22",
"fileAs": "Fort, Garth",
"displayName": "Garth Fort",
"givenName": "Garth",
"initials": "G.F.",
"middleName": null,
"nickName": "Garth",
"surname": "Fort",
"title": null,
"yomiGivenName": null,
"yomiSurname": null,
"yomiCompanyName": null,
"generation": null,
"emailAddresses": [
{
"name": "Garth",
"address": "garth@contoso.com",
"type": "unknown"
},
{
"name": "Garth",
"address": "garth@contoso.com",
"type": "personal"
}
],
"imAddresses": [
"sip:garthf@contoso.com"
],
"jobTitle": "Web Marketing Manager",
"companyName": "Contoso, Inc.",
"department": "Sales & Marketing",
"officeLocation": "20/1101",
"profession": null,
"assistantName": null,
"manager": null,
"phones": [{
"type": "business",
"number": "+1 918 555 0101"
}],
"postalAddresses": [{
"type": "business",
"postOfficeBox": "P.O. Box 100",
"street": "123 Some street",
"city": "Seattle",
"state": "WA",
"countryOrRegion": "USA",
"postalCode": "98121"
}],
"spouseName": null,
"personalNotes": null,
"children": [],
"gender": null,
"websites": [{
"type": "work",
"address": "https://www.contoso.com",
"name": "Contoso"
}],
"weddingAnniversary": null
}