Вывод контакта
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение свойств и связей объекта контакта.
Существует два сценария, в которых приложение может получить контакт в папке контактов другого пользователя:
- У приложения есть разрешения для приложений; или
- У приложения есть соответствующие делегированные разрешения от одного пользователя, а другой пользователь поделился с ним папкой контактов или предоставил ему делегированный доступ. См. подробные сведения и пример.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Contacts.Read | Contacts.ReadWrite |
Делегированные (личная учетная запись Майкрософт) | Contacts.Read | Contacts.ReadWrite |
Для приложений | Contacts.Read | Contacts.ReadWrite |
HTTP-запрос
Контакт в почтовом ящике пользователя.
GET /me/contacts/{id}
GET /users/{id | userPrincipalName}/contacts/{id}
Контакт из контакта верхнего уровняFolder пользователя.
GET /me/contactfolders/{Id}/contacts/{id}
GET /users/{id | userPrincipalName}/contactfolders/{id}/contacts/{id}
Объект contact из дочерней папки в папке contactFolder. Приведенный ниже пример показывает один уровень вложенности, но для хранения контакта допускается несколько.
GET /me/contactFolders/{id}/childFolders/{id}/.../contacts/{id}
GET /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}
Необязательные параметры запросов
Имя | Значение | Описание |
---|---|---|
$expand | string | Список отношений, развертываемых и включаемых в ответ (разделитель — запятая). Поддерживаемые имена см. в таблице связей объекта contact . |
$select | string | Разделенный запятыми список свойств, включаемых в ответ. |
Заголовки запросов
Заголовок | Значение |
---|---|
Авторизация | Bearer {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
}