Kontakte auflistenList contacts

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Kontakte im Postfach des Benutzers abrufen.Get contacts in the user's mailbox.

Es gibt zwei Szenarien, in denen eine App Kontakte im Kontaktordner eines anderen Benutzers abrufen kann:There are two scenarios where an app can get contacts in another user's contact folder:

  • Wenn die App Anwendungsberechtigungen besitzt oderIf the app has application permissions, or,
  • Wenn die App die entsprechenden delegierten Berechtigungen von einem Benutzer besitzt und ein anderer Benutzer einen Kontaktordner für diesen Benutzer freigegeben hat oder diesem Benutzer delegierten Zugriff erteilt hat.If the app has the appropriate delegated permissions from one user, and another user has shared a contact folder with that user, or, has given delegated access to that user. Hier finden Sie weitere Informationen und ein Beispiel.See details and an example.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
AnwendungApplication Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite

HTTP-AnforderungHTTP request

So rufen Sie alle Kontakte in einem Benutzerpostfach ab:To get all the contacts in a user's mailbox:

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

So rufen Sie Kontakte in einem spezifischen Ordner in einem Benutzerpostfach ab:To get contacts in a specific folder in the user's mailbox:

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

Optionale AbfrageparameterOptional query parameters

Sie können den $filter-Abfrageparameter verwenden, um Kontakte anhand der E-Mail-Adressen zu filtern:You can use the $filter query parameter to filter contacts based on their email addresses:

GET https://graph.microsoft.com/beta/me/contacts?$filter=emailAddresses/any(a:a/address eq 'garth@contoso.com')

Beachten Sie, dass Sie den $filter-, any- und den eq-Operator nur für die address-Untereigenschaft der Instanzen einer emailAddresses-Sammlung verwenden können.Note that you can use $filter, any, and the eq operator on only the address sub-property of instances in an emailAddresses collection. Sie können also weder nach name oder einer anderen Untereigenschaft einer Instanz von emailAddresses filtern noch einen anderen Operator oder eine andere Funktion mit filter anwenden, z. B. ne, le und startswith().That is, you cannot filter on the name or any other sub-property of an instance of emailAddresses, nor can you apply any other operator or function with filter, such as ne, le, and startswith().

Allgemeine Informationen zu dem $filter-Abfrageparameter finden Sie unter OData-Abfrageparameter.For general information on the $filter query parameter, see OData query parameters.

AnforderungsheaderRequest headers

KopfzeileHeader WertValue
AuthorizationAuthorization Bearer {token}. Erforderlich.Bearer {token}. Required.

AnforderungstextRequest body

Geben Sie für diese Methode keinen Anforderungstext an.Do not supply a request body for this method.

AntwortResponse

Wenn die Methode erfolgreich verläuft, 200 OK werden der Antwortcode und eine Sammlung von Contact -Objekten im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and collection of contact objects in the response body.

BeispielExample

AnforderungRequest

Im folgenden Beispiel werden die Eigenschaften DisplayName und Email Adressen der Kontakte des angemeldeten Benutzers abgerufen.The following example gets the displayName and emailAddresses properties of the signed-in user's contacts.

GET https://graph.microsoft.com/beta/me/contacts?$select=displayName,emailAddresses
AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort. Hinweis: Das hier gezeigte Antwortobjekt ist möglicherweise aus Platzgründen abgeschnitten. Von einem tatsächlichen Aufruf werden alle Eigenschaften zurückgegeben.Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('c3e1fcd2-db78-42a8-aec5-1f2cd59abb5c')/contacts(displayName,emailAddresses)",
    "value":[
        {
            "@odata.etag":"W/\"EQAAABYAAACv7At+UNVFRLhGciJGF6v5AAAve7f6\"",
            "id":"AAMkADh6v5AAAvgTCFAAA=",
            "displayName":"Elvis Blank",
            "emailAddresses":[
                {
                    "type":"personal",
                    "name":"Elvis Blank",
                    "address":"elvisb@relecloud.onmicrosoft.com"
                },
                {
                    "type":"other",
                    "otherLabel":"Volunteer work",
                    "name":"Elvis Blank",
                    "address":"elvisb@fabrikam.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.etag":"W/\"EQAAABYAAACv7At+UNVFRLhGciJGF6v5AAAve7fn\"",
            "id":"AAMkADh6v5AAAvgTCEAAA=",
            "displayName":"Pavel Bansky",
            "emailAddresses":[
                {
                    "type":"personal",
                    "name":"Pavel Bansky",
                    "address":"pavelb@contoso.onmicrosoft.com"
                },
                {
                    "type":"other",
                    "otherLabel":"Volunteer work",
                    "name":"Pavel Bansky",
                    "address":"pavelb@fabrikam.onmicrosoft.com"
                }
            ]
        }
    ]
}