1. Hilfe
  2. Wie man über die API mit sender-solutions.com arbeitet
  3. 5. Abrufen der Abonnentenliste über die API

5. Abrufen der Abonnentenliste über die API

5. Abrufen der Abonnentenliste über die API

Die Methode ist zum Abrufen der Liste der Abonnenten vorgesehen. Sie kann für die Suche nach einem bestimmten Satz von Filtern verwendet werden. Alle Parameter sind optional. Die Daten werden in Query-Parametern im Link übergeben.

HTTP-Anfrage
  • URL: https://sender-solutions.com/api/subscribers/subscribers-list/
  • HTTP-Methode: GET
Beispiel einer Anfrage mit maximalem Satz von Parametern unter Verwendung von cURL

curl --location 'https://sender-solutions.com/api/subscribers/subscribers-list/?offset=0&limit=10&Id=25&BaseId=13&ClientUserId=ClientUserId12345&Email=username%40example.com&IsActive=1&FirstName=Cat&LastName=Catstone&Gender=male' \
--header 'Authorization: {{api-token}}'
Beschreibung der Felder
Feld Typ Obligatorisch Beschreibung
offset int Anzahl der gefundenen Abonnenten aus der Ergebnisliste, die übersprungen werden sollen. Notwendig für die Möglichkeit des portionsweisen (seitenweisen) Lesens der Daten. Standardmäßig — 0.
limit int Maximale Anzahl der Abonnenten, die in der Antwort auf diese Anfrage zurückgegeben werden. Notwendig für die Möglichkeit des portionsweisen (seitenweisen) Lesens der Daten. Standardmäßig — 50, maximal — 1000.
Id int Kennung des Abonnenten. Wenn angegeben — wird als Filter verwendet.
BaseId int Kennung der Abonnentenbasis. Wenn angegeben — wird als Filter verwendet.
ClientUserId string ID des Abonnenten im System des Kunden. Wenn angegeben — wird als Filter verwendet.
Email string E-Mail des Abonnenten. Wenn angegeben — wird als Filter verwendet.
IsActive int Aktivitäts-Flag des Abonnenten. Wenn angegeben — wird als Filter verwendet. Geben Sie 0 für die Suche nach inaktiven Abonnenten und 1 — für aktive an.
FirstName string Vorname des Abonnenten. Wenn angegeben — wird als Filter verwendet.
LastName string Nachname des Abonnenten. Wenn angegeben — wird als Filter verwendet.
Gender string Geschlecht des Abonnenten. Wenn angegeben — wird als Filter verwendet. Mögliche Werte: "male" — männlich, "female" — weiblich, leere Zeichenkette — Wert «Nicht angegeben».
Beispiel einer erfolgreichen Antwort im JSON-Format
{
    "success": true,
    "SubscribersList": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 10,
        "Subscribers": [
            {
                "Id": 25,
                "Base": {
                    "Id": 13,
                    "Name": "Test Users"
                },
                "IsActive": true,
                "Email": "username@example.com",
                "FirstName": "Cat",
                "LastName": "Catstone",
                "Gender": "male",
                "Phone": "+380111222333",
                "Tags": [
                    "api",
                    "test-user"
                ],
                "ClientUserId": "ClientUserId12345",
                "CustomField1": "CustomValue1",
                "CustomField2": "CustomValue2",
                "CustomField3": "CustomValue3",
                "Address": {
                    "Country": "UA",
                    "City": "Odesa",
                    "State": "",
                    "Zip": "65000",
                    "Line1": "Very Long street",
                    "Line2": "building 42",
                    "Line3": ""
                },
                "Birthday": "2002-04-15"
            }
        ]
    }
}

In dieser Antwort bedeutet das Feld SubscribersList.TotalCount die Gesamtzahl der nach der Anfrage gefundenen Abonnenten. Die Felder SubscribersList.Offset und SubscribersList.Limit duplizieren die Werte aus der Anfrage unter Berücksichtigung der Beschränkungen für Minimal- und Maximalwerte. Das Feld SubscribersList.Subscribers enthält ein Array von Abonnenten.