Outlook-Kontakte-REST-API-Verweis (Version 1.0)

Artikel
06/30/2018

Hinweis

Version 1.0 der Outlook REST-API ist veraltet. Ab dem 1. November 2018 können Apps die Standardauthentifizierung nicht mehr mit dem REST-Endpunkt v1.0 verwenden. Ab dem 1. November 2019 wird der v1.0 REST-Endpunkt vollständig stillgelegt und die v1.0-Dokumentation kurz darauf entfernt. Starten Sie die Migration Ihrer App zur Verwendung der Outlook REST-API in v1.0 von Microsoft Graph. Weitere Details finden Sie in unserer Ankündigung.

Die Outlook-Kontakte-API bietet Zugriff auf die Kontakte und die Kontaktordner eines Benutzers, die durch Azure Active Directory auf Office 365 geschützt sind, sowie auf ähnliche Daten in Microsoft-Konten speziell in diesen Domänen: Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com.

Hinweis

Zur Vereinfachung des Verweises verwendet der Rest dieses Artikels Outlook.com, um diese Microsoft-Konto-Domänen mit einzuschließen.

Kein Interesse an v1.0 der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zu Office 365 REST API-Referenz und wählen Sie die gewünschte Version aus.

Alle Kontakt-API-Operationen

Kontakt-Operationen

Kontakte werden im Kontakt-Ordner gespeichert. Sie können Kontakte abrufen, erstellen, ändern und löschen.

Kontakte erhalten
Kontakte und Kontaktordner synchronisieren
Kontakte erstellen
Kontakte aktualisieren
Kontakte löschen

Kontakt-Ordner Operationen

Kontakt-Ordner können Kontakte und andere Kontakt-Ordner enthalten. Sie können Kontaktordner abrufen und Kontakte in einem Kontaktordner erstellen.

Kontaktordner abrufen

Kontakt-Foto Operationen

Jeder Kontakt kann ein optionales Kontakt-Foto beinhalten. Sie können ein Foto für einen Kontakt abrufen oder einstellen.

Kontaktfoto erhalten
Ein Kontaktfoto festlegen

Siehe auch

Verwendung der REST-API Kontakte

Authentifizierung

Wie andere Outlook REST API, sollten Sie für jede Anfrage an die Kontakte-API ein gültiges Zugriffstoken angeben. Um ein Zugangstoken zu erhalten, müssen Sie Ihre Anwendung registriert und identifiziert haben und die entsprechende Autorisierung erhalten haben.

Sie können mehr über einige optimierte Registrierungs- und Autorisierungsoptionen für Sie herausfinden. Beachten Sie dies, wenn Sie mit den spezifischen Operationen in der Kontakte-API fortfahren.

Version von API

Die Kontakte REST API wird in allen Versionen der Outlook REST API unterstützt. Die Funktionalität kann je nach spezifischer Version unterschiedlich sein.

Ziel-Benutzer

Die Kontakt-API-Anfragen werden immer im Namen des aktuellen Benutzers ausgeführt.

Siehe Verwenden Sie die Outlook REST API für weitere Informationen, die allen Untergruppen von Outlook REST API gemeinsam sind.

Kontakte erhalten

Sie können eine Kontaktsammlung oder einen einzelnen Kontakt aus einem Kontaktordner erhalten.

Eine Kontaktsammlung erhalten
Abrufen eines Kontakts

Eine Kontaktsammlung erhalten

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.read
wl.basic

Dient zum Abrufen einer Kontaktsammlung aus dem Standardkontaktordner des angemeldeten Benutzers (.../me/contacts) oder aus dem angegebenen Kontaktordner.

GET https://outlook.office.com/api/v1.0/me/contacts
GET https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}/contacts

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_folder_id	Zeichenfolge	Die Kontaktordner-ID, wenn Sie Kontakte aus einem bestimmten Ordner erhalten.

Hinweis

Standardmäßig umfasst jeder Kontakt in der Antwort alle seine Eigenschaften. Verwenden Sie $select, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.

Das folgende Beispiel zeigt, wie man $select verwendet, um nur die E-Mail-Adressen, Vornamen und Nachnamen als Eigenschaften des Kontakts in der Antwort anzugeben. Lesen Sie die Stichprobenantwort Erhalten Sie einen Kontakt für eine vollständige Liste der Eigenschaften, die für einen Kontakt zurückgegeben würden, wenn Sie nicht $selectverwenden.

Beispielanfrage

GET https://outlook.office.com/api/v1.0/me/contacts?$select=EmailAddresses,GivenName,Surname

Beispielantwort

Statuscode: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa6\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk2AAA=",
            "GivenName": "Pavel",
            "Surname": "Bansky",
            "EmailAddresses": [
                {
                    "Name": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa5\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk1AAA=",
            "GivenName": "Katie",
            "Surname": "Jordan",
            "EmailAddresses": [
                {
                    "Name": "katiej@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk0AAA=",
            "GivenName": "Garth",
            "Surname": "Fort",
            "EmailAddresses": [
                {
                    "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa6\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk2AAA=",
            "GivenName": "Pavel",
            "Surname": "Bansky",
            "EmailAddresses": [
                {
                    "Name": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa5\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk1AAA=",
            "GivenName": "Katie",
            "Surname": "Jordan",
            "EmailAddresses": [
                {
                    "Name": "katiej@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk0AAA=",
            "GivenName": "Garth",
            "Surname": "Fort",
            "EmailAddresses": [
                {
                    "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}

Antworttyp

Die gewünschte Kontakt Sammlung.

Abrufen eines Kontakts

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.read
wl.basic

Mit der Kontakt-ID einen Kontakt abrufen

GET https://outlook.office.com/api/{version}/me/contacts/{contact_id}

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
Version	Zeichenfolge	Die Version der API.
contact_id	Zeichenfolge	Die Kontakt-ID.

Beispielanfrage

GET https://outlook.office.com/api/v1.0/me/contacts/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop

Beispielantwort

Statuscode: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk0AAA=",
    "DateTimeCreated": "2014-10-19T23:08:24Z",
    "DateTimeLastModified": "2014-10-19T23:08:24Z",
    "ChangeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4",
    "Categories": [],
    "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
    "Birthday": null,
    "FileAs": "Fort, Garth",
    "DisplayName": "Garth Fort",
    "GivenName": "Garth",
    "Initials": null,
    "MiddleName": null,
    "NickName": null,
    "Surname": "Fort",
    "Title": null,
    "YomiGivenName": null,
    "YomiSurname": null,
    "YomiCompanyName": null,
    "Generation": null,
    "EmailAddresses": [
        {
            "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
            "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
    ],
    "ImAddresses": [
        "sip:garthf@a830edad9050849nda1.onmicrosoft.com"
    ],
    "JobTitle": "Web Marketing Manager",
    "CompanyName": null,
    "Department": "Sales & Marketing",
    "OfficeLocation": "20/1101",
    "Profession": null,
    "BusinessHomePage": null,
    "AssistantName": null,
    "Manager": null,
    "HomePhones": [],
    "MobilePhone1": null,
    "BusinessPhones": [
        "+1 918 555 0101"
    ],
    "HomeAddress": {},
    "BusinessAddress": {},
    "OtherAddress": {},
    "SpouseName": null,
    "PersonalNotes": null,
    "Children": []
}

Antworttyp

Der gewünschte Kontakt.

Hinweis

Standardmäßig enthält die Antwort alle Eigenschaften des Kontakts. Verwenden Sie $select, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.

Das folgende Beispiel zeigt, wie man $select verwendet, um nur die E-Mail-Adressen, Vornamen und Nachnamen als Eigenschaften des Kontakts in der Antwort anzugeben.

Beispielanfrage

GET https://outlook.office.com/api/v1.0/me/contacts/AAMkAGI2THk0AAA=?$select=EmailAddresses,GivenName,Surname

Beispielantwort

Statuscode: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkAGI2THk0AAA=",
    "GivenName": "Garth",
    "Surname": "Fort",
    "EmailAddresses": [
        {
            "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
            "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
    ]
}

Kontakte und Kontaktordner synchronisieren

Sie können Ihre lokale Kontaktliste mit den Kontakten auf dem Server synchronisieren. Die Kontaktsynchronisation ist ein Vorgang pro Ordner, z.B. können Sie alle Kontakte in Ihrem Stammordner Kontakte synchronisieren. Wenn Sie zusätzliche Kontaktordner haben, müssen Sie jeden Ordner einzeln synchronisieren.

Die Synchronisation unterstützt nur die vollständige Synchronisation; alle Kontakte im angegebenen Ordner werden bei jeder Anfrage zurückgegeben.

Die Synchronisation eines Kontaktordners erfordert in der Regel zwei oder mehr GET-Anforderungen. Sie machen die GET-Anforderung ähnlich wie die Art und Weise, wie Sie Kontakte erhalten, außer dass Sie die folgenden Anforderungs-Header hinzufügen.

Sie müssen den Header Präferenz: odata.track-changes in allen Ihren Synchronisierungs-Anforderungen angeben.
Sie können den Header Prefer: odata.maxpages={n} angeben, um die maximale Anzahl der in jeder Anfrage zurückgegebenen Kontakte festzulegen.

Die zweite und nachfolgende GET-Anfrage unterscheiden sich von der ersten GET-Anfrage, indem sie entweder einen deltaToken oder einen skipToken enthalten, der in einer früheren Antwort empfangen wurde.

Die erste Antwort auf eine Sync-Anforderung liefert immer einen deltaToken. Sie sollten immer eine zweite GET-Anfrage mit deltaToken stellen, um festzustellen, ob zusätzliche Kontakte vorhanden sind. Die zweite Anfrage liefert zusätzliche Kontakte und entweder ein skipToken wenn mehr Kontakte verfügbar sind, oder ein deltaToken wenn der letzte Kontakt gesendet wurde.

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.read
wl.basic

GET https://outlook.office.com/api/v1.0/me/Contacts
GET https://outlook.office.com/api/v1.0/me/ContactFolders/{folderName}

Erforderliche Parameter	Typ	Beschreibung
Header-Parameter
Bevorzugt	odata.track-Änderungen	Zeigt an, dass es sich bei der Anforderung um eine Synchronisations-Anforderung handelt.
Bevorzugt	odata.maxpagesize	Legt die Anzahl der in jeder Antwort zurückgegebenen Kontakte fest.
URL-Parameter
folderName	Zeichenfolge	Der Name des zu synchronisierenden Ordners.
odata.deltaLink	Zeichenfolge	Das Token, das das letzte Mal anzeigt, dass der Ordner synchronisiert wurde.
odata.skiptoken	Zeichenfolge	Das Token, das anzeigt, dass mehr Nachrichten heruntergeladen werden müssen.

Antworttyp

Eine Sammlung mit den angeforderten Kontakten und einem deltaToken , mit dem Sie zusätzliche Seiten mit Kontaktdaten vom Server anfordern und eine inkrementelle Synchronisation anfordern können. Ist die Anzahl der zurückgegebenen Kontakte größer als der im odata.maxpagesize -Header angegebene Wert, wird die Antwort auf mehreren Seiten zurückgegeben.

Die Antwort wird einen Header Präferenz Angewendet: odata-trackchanges enthalten. Wenn Sie versuchen, eine Ressource zu synchronisieren, die nicht unterstützt wird, wird dieser Header in der Antwort nicht zurückgegeben. Überprüfen Sie diesen Header, bevor Sie die Antwort bearbeiten, um Fehler zu vermeiden.

Hinweis

Standardmäßig enthält die Antwort alle Eigenschaften der angegebenen Kontakte. Verwenden Sie $select , um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Verwenden Sie nicht $filter, $orderby, $search oder $top, da diese nicht für die Synchronisation von Kontakten oder Kontaktordnern unterstützt werden. Siehe ODaten-Abfrageparameter für weitere Details.

Beispiele

Initiale Anforderung für eine Vollsynchronisation:

GET https://outlook.office.com/api/v1.0/Me/Contacts

Schließen Sie die folgenden Header mit ein:

Bevorzugt: odata.track-changes
Bevorzugt: odata.maxpagesize=100

Zweite Anforderung an den Server nach einer vollständigen Synchronisationsanforderung:

https://outlook.office.com/api/v1.0/Me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

Schließen Sie die folgenden Header mit ein:

Bevorzugt: odata.track-changes
Bevorzugt: odata.maxpagesize=100

Zweite Antwort vom Server mit zusätzlichen verfügbaren Seiten:

Kopfzeile

Präferenz-Anwendung: odata.track-changes

Text

@odata.deltaLink=https://outlook.office.com/api/v1.0/me/Contacts/messages/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

Nutzlast-Nachrichten

Zweite oder nachfolgende Antwort vom Server, wenn alle Kontakte gesendet wurden:

Kopfzeile

Präferenz-Anwendung: odata.track-changes

Text

@odata.deltaLink=https://outlook.office.com/api/v1.0/me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

Nutzlast-Nachrichten

Anfrage an den Server, wenn zusätzliche Seiten verfügbar sind:

https://outlook.office.com/api/v1.0/Me/Contacts/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

Schließen Sie die folgenden Header mit ein:

Bevorzugt: odata.track-changes
Bevorzugt: odata.maxpagesize=100

Kontakte erstellen

Erstellen Sie einen Kontakt im angegebenen Ordner Kontakte.

Erstellen von Kontakten

Erstellen von Kontakten

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.readwrite
wl.contacts_create

Dient zum Hinzufügen eines Kontakts zum Stammordner der Kontakte oder zum Endpunkt contacts eines anderen Kontaktordners.

POST https://outlook.office.com/api/v1.0/me/contacts
POST https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}/contacts

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_folder_id	Zeichenfolge	Die Kontaktordner-ID, wenn Sie einen Kontakt in einem bestimmten Kontaktordner erstellen.
Textparameter
GivenName	Zeichenfolge	Der Vorname des Kontakts.

Geben Sie den Parameter GivenName und alle beschreibbaren Kontakt Eigenschaften im Anfragetext an.

Beispielanfrage

POST https://outlook.office.com/api/v1.0/me/contacts

Content-Type: application/json

{
  "GivenName": "Pavel",
  "Surname": "Bansky",
  "EmailAddresses": [
    {
      "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Pavel Bansky"
    }
  ],
  "BusinessPhones": [
    "+1 732 555 0102"
  ]
}

Beispielantwort

Statuscode: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"EQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAV41eC\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEOAAAmP1Ln1wcHRariNdTMGAO9AAAV4xqVAAA=",
  "ChangeKey": "EQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAV41eC",
  "Categories": [],
  "DateTimeCreated": "2014-10-22T20:38:18Z",
  "DateTimeLastModified": "2014-10-22T20:38:19Z",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEOAAA=",
  "Birthday": null,
  "FileAs": "",
  "DisplayName": "Pavel Bansky",
  "GivenName": "Pavel",
  "Initials": null,
  "MiddleName": null,
  "NickName": null,
  "Surname": "Bansky",
  "Title": null,
  "Generation": null,
  "EmailAddresses": [
    {
      "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Pavel Bansky"
    },
    null,
    null
  ],
  "ImAddresses": [
    null,
    null,
    null
  ],
  "JobTitle": null,
  "CompanyName": null,
  "Department": null,
  "OfficeLocation": null,
  "Profession": null,
  "BusinessHomePage": null,
  "AssistantName": null,
  "Manager": null,
  "HomePhones": [
    null,
    null
  ],
  "BusinessPhones": [
    "+1 732 555 0102",
    null
  ],
  "MobilePhone1": null,
  "HomeAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "BusinessAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "OtherAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "YomiSurname": null,
  "YomiGivenName": null,
  "YomiCompanyName": null
}

Antworttyp

Der neue Kontakt.

Kontakte aktualisieren

Ändern Sie die Eigenschaften eines Kontakts.

Einen Kontakt aktualisieren

Einen Kontakt aktualisieren

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.readwrite
wl.contacts_create

Geben Sie alle beschreibbaren Kontakt- Eigenschaften im Anfragetext an. Nur die Eigenschaften, die Sie angeben, werden geändert.

PATCH https://outlook.office.com/api/v1.0/me/contacts/{contact_id}

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_id	Zeichenfolge	Die Kontakt-ID.

Beispielanfrage

PATCH https://outlook.office.com/api/v1.0/me/contacts/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=

Content-Type: application/json

{
  "HomeAddress": {
    "Street": "Some street",
    "City": "Seattle",
    "State": "WA",
    "PostalCode": "98121"
  },
  "Birthday": "1974-07-22"
}

Beispielantwort

Statuscode: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=",
  "ChangeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3",
  "Categories": [],
  "DateTimeCreated": "2014-10-19T23:08:18Z",
  "DateTimeLastModified": "2014-10-19T23:08:18Z",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
  "Birthday": "1974-07-22T00:00:00Z",
  "FileAs": "Schorr, Janet",
  "DisplayName": "Janet Schorr",
  "GivenName": "Janet",
  "Initials": null,
  "MiddleName": null,
  "NickName": null,
  "Surname": "Schorr",
  "Title": null,
  "Generation": null,
  "EmailAddresses": [
    {
      "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "janets@a830edad9050849NDA1.onmicrosoft.com"
    },
    null,
    null
  ],
  "ImAddresses": [
    "sip:janets@a830edad9050849nda1.onmicrosoft.com",
    null,
    null
  ],
  "JobTitle": "Product Marketing Manager",
  "CompanyName": null,
  "Department": "Sales &amp; Marketing",
  "OfficeLocation": "18/2111",
  "Profession": null,
  "BusinessHomePage": null,
  "AssistantName": null,
  "Manager": null,
  "HomePhones": [
    null,
    null
  ],
  "BusinessPhones": [
    "+1 425 555 0109",
    null
  ],
  "MobilePhone1": null,
  "HomeAddress": {
    "Street": "Some street",
    "City": "Seattle",
    "State": "WA",
    "CountryOrRegion": null,
    "PostalCode": "98121"
  },
  "BusinessAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "OtherAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "YomiSurname": null,
  "YomiGivenName": null,
  "YomiCompanyName": null
}

Antworttyp

Der aktualisierte Kontakt.

Kontakte löschen

Mit dieser API können Sie Kontakte löschen. Gelöschte Inhalte können möglicherweise nicht wiederhergestellt werden.

Weitere Informationen finden Sie unter Löschen von Elementen mithilfe von EWS in Exchange.

Einen Kontakt löschen

Einen Kontakt löschen

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.readwrite
wl.contacts_create

DELETE https://outlook.office.com/api/v1.0/me/contacts/{contact_id}

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_id	Zeichenfolge	Die Kontakt-ID.

Beispielanfrage

DELETE https://outlook.office.com/api/v1.0/me/contacts/AAMkAGE0Myy2hAAA=

Beispielantwort

Status code: 204

Kontaktordner abrufen

Sie können eine Sammlung von Kontaktordnern oder einen Kontaktordner erhalten.

Eine Kontaktordner-Sammlung erhalten
Einen Kontaktordner erhalten

Eine Kontaktordner-Sammlung erhalten

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.read
wl.basic

Abrufen der Kontaktordner-Sammlung unter dem Standardordner Kontakte des angemeldeten Benutzers (.../me/contactfolders) oder unter dem angegebenen Kontaktordner.

GET https://outlook.office.com/api/v1.0/me/contactfolders
GET https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}/childfolders

Hinweis

Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_folder_id	Zeichenfolge	Die Kontaktordner-ID, wenn Sie Kontaktordner aus einem bestimmten Kontaktordner erhalten.

Beispielanfrage

GET https://outlook.office.com/api/v1.0/me/contactfolders

Beispielantwort

Statuscode: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/ContactFolders",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAADTKI5AAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
      "DisplayName": "Finance"
    }
  ]
}

Antworttyp

Die gewünschte Kontakt-Ordner Sammlung.

Einen Kontaktordner erhalten

Minimal benötigter Bereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.read
wl.basic

Dient zum Abrufen eines Kontaktordners anhand der Kontaktordner-ID.

GET https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}

Hinweis

Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_folder_id	Zeichenfolge	Die Kontaktordner-ID.

Beispielanfrage

GET https://outlook.office.com/api/v1.0/me/contactfolders/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAADTKI5AAA=

Beispielantwort

Statuscode: 200

{
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAADTKI5AAA=",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
  "DisplayName": "Finance"
}

Antworttyp

Der gewünschte Kontakt-Ordner.

Kontaktfoto und Metadaten erhalten

Dieses Feature ist in v2.0 und beta verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

Ein Kontaktfoto festlegen

Dieses Feature ist in v2.0 und beta verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

Nächste Schritte

Egal, ob Sie bereit sind, eine App zu erstellen oder einfach nur mehr darüber erfahren möchten, wir haben alles im Griff.

Beginnen Sie mit den E-Mail-, Kalender- und Kontakte-REST-APIs.
Möchten Sie Beispiele sehen? Wir haben sie.

Oder erfahren Sie mehr über die Verwendung der Office 365-Plattform:

Outlook-Kontakte-REST-API-Verweis (Version 1.0)

Alle Kontakt-API-Operationen

Kontakt-Operationen

Kontakt-Ordner Operationen

Kontakt-Foto Operationen

Siehe auch

Verwendung der REST-API Kontakte

Authentifizierung

Version von API

Ziel-Benutzer

Kontakte erhalten

Eine Kontaktsammlung erhalten

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Antworttyp

Abrufen eines Kontakts

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Antworttyp

Beispielanfrage

Beispielantwort

Kontakte und Kontaktordner synchronisieren

Minimal benötigter Bereich

Antworttyp

Beispiele

Kontakte erstellen

Erstellen von Kontakten

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Antworttyp

Kontakte aktualisieren

Einen Kontakt aktualisieren

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Antworttyp

Kontakte löschen

Einen Kontakt löschen

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Kontaktordner abrufen

Eine Kontaktordner-Sammlung erhalten

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Antworttyp

Einen Kontaktordner erhalten

Minimal benötigter Bereich

Beispielanfrage

Beispielantwort

Antworttyp

Kontaktfoto und Metadaten erhalten

Ein Kontaktfoto festlegen

Nächste Schritte

Zusätzliche Ressourcen