Outlook-Kontakte – REST-API-Verweis

Artikel
06/30/2018

Hinweis

Diese Dokumentation behandelt die Beta-Version der Kontakt-API in der Vorschauversion. Die Funktionen der Vorschauversion können vor der Fertigstellung geändert werden und können den Code, der sie verwendet, unterbrechen. Aus diesem Grund sollten Sie in der Regel nur eine Produktionsversion einer API in Ihrem Produktionscode verwenden. Falls vorhanden, ist v2.0 derzeit die bevorzugte Version.

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-Kontodomänen aufzunehmen.

Sie interessieren sich nicht für die Beta-Version der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite auf den Abschnitt Office 365 REST API Verweis und wählen Sie die gewünschte Version aus.

Alle Kontakt-API-Operationen

Kontakt-Operationen

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

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

Kontaktordner Operationen

Kontaktordner können Kontakte und andere Kontaktordner 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.

Kontakt-Foto abrufen
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.

Benötigter Mindestbereich

Eine der folgenden Varianten:

https://outlook.office.com/contacts.read
wl.basic
Eine Kontaktsammlung erhalten
Abrufen eines Kontakts

Eine Kontaktsammlung erhalten

Erhalten Sie alle Kontakte im Postfach des angemeldeten Benutzers (.../me/contacts) oder aus dem angegebenen Kontaktordner.

GET https://outlook.office.com/api/beta/me/contacts
GET https://outlook.office.com/api/beta/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

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.

Beispielanfrage

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

Beispielantwort

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk3AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2THk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THkzAAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2THkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}

Antworttyp

Die gewünschte Kontakt-Sammlung.

Abrufen eines Kontakts

Benötigter Mindestbereich

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/beta/me/contacts/{contact_id}

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

Antworttyp

Der gewünschte Kontakt.

Beispielanfrage

GET https://outlook.office.com/api/beta/me/contacts/AAMkADlkAAAMRFUEAAA=

Beispielantwort

Status code: 200

{
    "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
    "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAAMRFUEAAA=')",
    "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAAMRdhl\"",
    "Id":"AAMkADlkAAAMRFUEAAA=",
    "CreatedDateTime":"2016-07-16T06:43:15Z",
    "LastModifiedDateTime":"2016-07-16T06:43:15Z",
    "ChangeKey":"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAAMRdhl",
    "Categories":[
    ],
    "ParentFolderId":"AAMkADlk8yAbgAAAAAAEkAAA=",
    "Birthday":null,
    "FileAs":"",
    "DisplayName":"Garret Vargas",
    "GivenName":"Garret",
    "Initials":null,
    "MiddleName":null,
    "NickName":null,
    "Surname":"Vargas",
    "Title":null,
    "YomiGivenName":null,
    "YomiSurname":null,
    "YomiCompanyName":null,
    "Generation":null,
    "EmailAddresses":[
        {
            "Name":"Garret Vargas",
            "Address":"GarretV@contoso.onmicrosoft.com"
        }
    ],
    "Websites":[
    ],
    "ImAddresses":[
        "sip:garretv@contoso.onmicrosoft.com"
    ],
    "JobTitle":"CVP Operations",
    "CompanyName":"",
    "Department":"Operations",
    "OfficeLocation":"36/2121",
    "Profession":null,
    "AssistantName":null,
    "Manager":null,
    "Phones":[
        {
            "Type":"Home",
            "Number":""
        },
        {
            "Type":"Business",
            "Number":"+1 206 555 0105"
        },
        {
            "Type":"Mobile",
            "Number":""
        }
    ],
    "PostalAddresses":[
        {
            "Type":"Business",
            "City":"Seattle"
        }
    ],
    "SpouseName":null,
    "PersonalNotes":null,
    "Children":[
    ],
    "Gender":null,
    "IsFavorite":null,
    "Flag":{
        "FlagStatus":"NotFlagged"
    }
}

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/beta/me/contacts/AAMkAGI2THk0AAA=?$select=EmailAddresses,GivenName,Surname

Beispielantwort

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAAMRFUEAAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkADlkAAAMRFUEAAA=",
    "GivenName": "Garth",
    "Surname": "Vargas",
    "EmailAddresses": [
       {
            "Name":"Garret Vargas",
            "Address":"GarretV@contoso.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.

Benötigter Mindestbereich

Eine der folgenden Varianten:

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

GET https://outlook.office.com/api/beta/me/Contacts
GET https://outlook.office.com/api/beta/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/beta/Me/Contacts

Fügen Sie die folgenden Header ein:

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

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

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

Fügen Sie die folgenden Header 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/beta/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/beta/me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

Nutzlast-Nachrichten

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

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

Fügen Sie die folgenden Header ein:

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

Kontakte erstellen

Erstellen Sie einen Kontakt im angegebenen Ordner Kontakte.

Erstellen von Kontakten

Benötigter Mindestbereich

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/beta/me/contacts
POST https://outlook.office.com/api/beta/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/beta/me/contacts
Content-Type: application/json

{
  "GivenName": "Pavel",
  "Surname": "Bansky",
  "EmailAddresses": [
    {
      "Address": "pavelb@contoso.onmicrosoft.com",
      "Name": "Pavel Bansky"
    }
  ],
  "Phones": [
    {
      "Type": "Business",
      "Number": "+1 732 555 0102"
    }
  ]
}

Beispielantwort

Status code: 201

{
  "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
  "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAARKMK7AAA=')",
  "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia\"",
  "Id":"AAMkADlkAAARKMK7AAA=",
  "CreatedDateTime":"2016-07-20T23:59:37Z",
  "LastModifiedDateTime":"2016-07-20T23:59:38Z",
  "ChangeKey":"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia",
  "Categories":[
  ],
  "ParentFolderId":"AAMkADlk8yAbgAAAAAAEOAAA=",
  "Birthday":null,
  "FileAs":"",
  "DisplayName":"Pavel Bansky",
  "GivenName":"Pavel",
  "Initials":null,
  "MiddleName":null,
  "NickName":null,
  "Surname":"Bansky",
  "Title":null,
  "YomiGivenName":null,
  "YomiSurname":null,
  "YomiCompanyName":null,
  "Generation":null,
  "EmailAddresses":[
    {
      "Name":"Pavel Bansky",
      "Address":"pavelb@contoso.onmicrosoft.com"
    }
  ],
  "Websites":[
  ],
  "ImAddresses":[
  ],
  "JobTitle":null,
  "CompanyName":null,
  "Department":null,
  "OfficeLocation":null,
  "Profession":null,
  "AssistantName":null,
  "Manager":null,
  "Phones":[
    {
      "Type":"Business",
      "Number":"+1 732 555 0102"
    }
  ],
  "PostalAddresses":[
  ],
  "SpouseName":null,
  "PersonalNotes":null,
  "Children":[
  ],
  "Gender":null,
  "IsFavorite":null,
  "Flag":{
    "FlagStatus":"NotFlagged"
  }
}

Antworttyp

Der neue Kontakt.

Kontakte aktualisieren

Ändern Sie die Eigenschaften eines Kontakts.

Einen Kontakt aktualisieren

Einen Kontakt aktualisieren

Benötigter Mindestbereich

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/beta/me/contacts/{contact_id}

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

Beispielanfrage

Im folgenden Beispiel werden die Kontaktadresse und ein Nachverfolgungskennzeichen festgelegt.

Hinweis

Wenn Flag.FlagStatus auf Flaggedgesetzt ist, kann ein Flag.CompletedDate nicht gesetzt werden.

PATCH https://outlook.office.com/api/beta/me/contacts/AAMkADlkAAARKMK7AAA=
Content-Type: application/json

{
  "PostalAddresses": [
    {
      "Type": "Business",
      "Street": "Some street",
      "City": "Seattle",
      "State": "WA",
      "PostalCode": "98121"
    }
  ],
  "Birthday": "1974-07-22",
  "Flag": {
    "FlagStatus": "Flagged",
       "DueDateTime": {
            "DateTime": "2017-12-22T08:00:00.0000000",
            "TimeZone": "UTC"
        },
        "StartDateTime": {
            "DateTime": "2017-12-18T08:00:00.0000000",
            "TimeZone": "UTC"
        }
    }
}

Beispielantwort

Status code: 200

{
  "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
  "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAARKMK7AAA=')",
  "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia\"",
  "Id":"AAMkADlkAAARKMK7AAA=",
  "CreatedDateTime":"2016-07-20T23:59:37Z",
  "LastModifiedDateTime":"2016-07-20T23:59:38Z",
  "ChangeKey":"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia",
  "Categories":[
  ],
  "ParentFolderId":"AAMkADlk8yAbgAAAAAAEOAAA=",
  "Birthday":"1974-07-22T00:00:00Z",
  "FileAs":"",
  "DisplayName":"Pavel Bansky",
  "GivenName":"Pavel",
  "Initials":null,
  "MiddleName":null,
  "NickName":null,
  "Surname":"Bansky",
  "Title":null,
  "YomiGivenName":null,
  "YomiSurname":null,
  "YomiCompanyName":null,
  "Generation":null,
  "EmailAddresses":[
    {
      "Name":"Pavel Bansky",
      "Address":"pavelb@contoso.onmicrosoft.com"
    }
  ],
  "Websites":[
  ],
  "ImAddresses":[
  ],
  "JobTitle":null,
  "CompanyName":null,
  "Department":null,
  "OfficeLocation":null,
  "Profession":null,
  "AssistantName":null,
  "Manager":null,
  "Phones":[
    {
      "Type":"Business",
      "Number":"+1 732 555 0102"
    }
  ],
  "PostalAddresses":[
    {
      "Type": "Business",
      "Street": "Some street",
      "City": "Seattle",
      "State": "WA",
      "PostalCode": "98121"
    }
  ],
  "SpouseName":null,
  "PersonalNotes":null,
  "Children":[
  ],
  "Gender":null,
  "IsFavorite":null,
  "Flag": {
        "FlagStatus": "Flagged",
        "DueDateTime": {
            "DateTime": "2017-12-22T08:00:00.0000000",
            "TimeZone": "UTC"
        },
        "StartDateTime": {
            "DateTime": "2017-12-18T08:00:00.0000000",
            "TimeZone": "UTC"
        }
  }
}

Beispielanfrage

Das folgende Beispiel setzt einen zuvor gekennzeichneten Kontakt auf Complete.

PATCH https://outlook.office.com/api/beta/me/contacts/AAMkADlkAAARKMK7AAA=
Content-Type: application/json

{
  "Flag": {
    "CompletedDateTime":{
      "DateTime": "2018-02-05T18:00:00",
      "TimeZone": "Pacific Standard Time"
    },
    "FlagStatus": "Complete"
  }
}

Beispielantwort

Status code: 200

{
  "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
  "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAARKMK7AAA=')",
  "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia\"",
  "Id":"AAMkADlkAAARKMK7AAA=",
  "CreatedDateTime":"2016-07-20T23:59:37Z",
  "LastModifiedDateTime":"2016-07-20T23:59:38Z",
  "ChangeKey":"EQAAABYAAABmngqUDhbeSLkRkXbBznTvAAEw/xwn",
  "Categories":[
  ],
  "ParentFolderId":"AAMkADlk8yAbgAAAAAAEOAAA=",
  "Birthday":"1974-07-22T00:00:00Z",
  "FileAs":"",
  "DisplayName":"Pavel Bansky",
  "GivenName":"Pavel",
  "Initials":null,
  "MiddleName":null,
  "NickName":null,
  "Surname":"Bansky",
  "Title":null,
  "YomiGivenName":null,
  "YomiSurname":null,
  "YomiCompanyName":null,
  "Generation":null,
  "EmailAddresses":[
    {
      "Name":"Pavel Bansky",
      "Address":"pavelb@contoso.onmicrosoft.com"
    }
  ],
  "Websites":[
  ],
  "ImAddresses":[
  ],
  "JobTitle":null,
  "CompanyName":null,
  "Department":null,
  "OfficeLocation":null,
  "Profession":null,
  "AssistantName":null,
  "Manager":null,
  "Phones":[
    {
      "Type":"Business",
      "Number":"+1 732 555 0102"
    }
  ],
  "PostalAddresses":[
    {
      "Type": "Business",
      "Street": "Some street",
      "City": "Seattle",
      "State": "WA",
      "PostalCode": "98121"
    }
  ],
  "SpouseName":null,
  "PersonalNotes":null,
  "Children":[
  ],
  "Gender":null,
  "IsFavorite":null,
  "Flag": {
    "FlagStatus": "Complete",
    "CompletedDateTime": {
        "DateTime": "2018-02-06T00:00:00.0000000",
        "TimeZone": "UTC"
    }
  }
}

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

Benötigter Mindestbereich

Eine der folgenden Varianten:

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

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

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

Beispielanfrage

DELETE https://outlook.office.com/api/beta/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

Benötigter Mindestbereich

Eine der folgenden Varianten:

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

Holen Sie sich alle Kontaktordner im Postfach des angemeldeten Benutzers (.../me/contactfolders) oder unter dem angegebenen Kontaktordner.

GET https://outlook.office.com/api/beta/me/contactfolders
GET https://outlook.office.com/api/beta/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/beta/me/contactfolders

Beispielantwort

Statuscode: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/ContactFolders",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AAMkAGI2TKI5AAA=')",
            "Id": "AAMkAGI2TKI5AAA=",
            "ParentFolderId": "AAMkAGI2AAEOAAA=",
            "DisplayName": "Finance",
            "WellKnownName": null
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AQMkADA1MTgAAAA==')",
            "Id": "AQMkADA1MTgAAAA==",
            "ParentFolderId": "AAMkAGI2AAEOAAA=",
            "DisplayName": "Contacts",
            "WellKnownName": "contacts"
        }
    ]
}

Antworttyp

Die gewünschte Kontaktordner-Sammlung.

Einen Kontaktordner erhalten

Benötigter Mindestbereich

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/beta/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/beta/me/contactfolders/AAMkAGI2TKI5AAA=

Beispielantwort

Statuscode: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/ContactFolders/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AAMkAGI2TKI5AAA=')",
    "Id": "AAMkAGI2TKI5AAA=",
    "ParentFolderId": "AAMkAGI2AAEOAAA=",
    "DisplayName": "Finance",
    "WellKnownName": null
}

Antworttyp

Der gewünschte Kontaktordner.

Kontakt-Foto abrufen

Benötigter Mindestbereich

Eine der folgenden Varianten:

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

Erhalten Sie das Foto des angegebenen Kontaktes des angemeldeten Benutzers.

GET https://outlook.office.com/api/beta/me/contacts('{contact_id}')/photo/$value

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_id	Zeichenfolge	Die ID, die den jeweiligen Kontakt des angemeldeten Benutzers angibt.

Beispielanfrage

GET https://outlook.office.com/api/beta/me/contacts('AAMkAGE1M2IyNGNm===')/photo/$value
Content-Type: image/jpg

Antwortdaten

Enthält die binären Daten des angeforderten Fotos. Der HTTP-Antwortcode ist 200.

Die Operation gibt HTTP 404 zurück, wenn der Kontakt noch kein Kontaktfoto auf Exchange Online hat.

Kontaktfoto-Metadaten erhalten

Benötigter Mindestbereich

Eine der folgenden Varianten:

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

Erhalten Sie die Metadaten eines Kontaktfotos, die den Inhaltstyp, die Breite und die Höhe in Pixeln enthalten.

GET https://outlook.office.com/api/beta/me/contacts('{contact_id}')/photo

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_id	Zeichenfolge	Die ID, die den jeweiligen Kontakt des angemeldeten Benutzers angibt.

Beispielanfrage

GET https://outlook.office.com/api/beta/me/contacts('AAMkAGE1M2IyNGNm')/photo

Daten der Beispielantwort

Eine erfolgreiche Anforderung gibt HTTP 200 zurück.

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Contacts('AAMkAGE1M2IyNGNm')/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-b826-40d7-b48b-57002df800e5@1717622f-49d1-4d0c-9d74-709fad664b77')/contacts('AAMkAGE1M2IyNGNm')/photo",
    "@odata.readLink": "https://outlook.office.com/api/beta/Users('ddfcd489-b826-40d7-b48b-57002df800e5@1717622f-49d1-4d0c-9d74-709fad664b77')/contacts('AAMkAGE1M2IyNGNm')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "Id": "103X77",
    "Width": 103,
    "Height": 77
}

Ein Kontaktfoto festlegen

Benötigter Mindestbereich

Eine der folgenden Varianten:

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

Weisen Sie dem angegebenen Kontakt des angemeldeten Benutzers ein Foto zu. Das Foto sollte binär sein. Es ersetzt jedes vorhandene Foto dieses Kontakts.

Verwenden Sie für diesen Vorgang nur PUT in der Betaversion.

PUT https://outlook.office.com/api/beta/me/contacts('{contact_id}')/photo/$value

Erforderliche Parameter	Typ	Beschreibung
URL-Parameter
contact_id	Zeichenfolge	Die ID, die den jeweiligen Kontakt des angemeldeten Benutzers angibt.

Beispielanfrage

PUT https://outlook.office.com/api/beta/me/contacts('AAMkAGE1M2IyNGNm===')/photo/$value
Content-Type: image/jpeg

Fügen Sie die Binärdaten des Fotos in den Text der Anfrage ein.

Antwortdaten

Eine erfolgreiche Anforderung gibt HTTP 200 zurück.

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

Alle Kontakt-API-Operationen

Kontakt-Operationen

Kontaktordner Operationen

Kontakt-Foto Operationen

Siehe auch

Verwendung der REST-API Kontakte

Authentifizierung

Version von API

Ziel-Benutzer

Kontakte erhalten

Benötigter Mindestbereich

Eine Kontaktsammlung erhalten

Beispielanfrage

Beispielantwort

Antworttyp

Abrufen eines Kontakts

Benötigter Mindestbereich

Antworttyp

Beispielanfrage

Beispielantwort

Beispielanfrage

Beispielantwort

Kontakte und Kontaktordner synchronisieren

Benötigter Mindestbereich

Antworttyp

Beispiele

Kontakte erstellen

Erstellen von Kontakten

Benötigter Mindestbereich

Beispielanfrage

Beispielantwort

Antworttyp

Kontakte aktualisieren

Einen Kontakt aktualisieren

Benötigter Mindestbereich

Beispielanfrage

Beispielantwort

Beispielanfrage

Beispielantwort

Antworttyp

Kontakte löschen

Einen Kontakt löschen

Benötigter Mindestbereich

Beispielanfrage

Beispielantwort

Kontaktordner abrufen

Eine Kontaktordner-Sammlung erhalten

Benötigter Mindestbereich

Beispielanfrage

Beispielantwort

Antworttyp

Einen Kontaktordner erhalten

Benötigter Mindestbereich

Beispielanfrage

Beispielantwort

Antworttyp

Kontaktfoto und Metadaten erhalten

Kontakt-Foto abrufen

Benötigter Mindestbereich

Beispielanfrage

Antwortdaten

Kontaktfoto-Metadaten erhalten

Benötigter Mindestbereich

Beispielanfrage

Daten der Beispielantwort

Ein Kontaktfoto festlegen

Benötigter Mindestbereich

Beispielanfrage

Antwortdaten

Nächste Schritte

Zusätzliche Ressourcen