1. Pomoc
  2. Jak pracować przez API z sender-solutions.com
  3. 5. Pobieranie listy subskrybentów przez API

5. Pobieranie listy subskrybentów przez API

5. Pobieranie listy subskrybentów przez API

Metoda przeznaczona jest do pobierania listy Subskrybentów. Może być używana do wyszukiwania według określonego zestawu filtrów. Wszystkie parametry są opcjonalne. Dane przekazywane są w parametrach query w linku.

Żądanie HTTP
  • URL: https://sender-solutions.com/api/subscribers/subscribers-list/
  • Metoda HTTP: GET
Przykład żądania z maksymalnym zestawem parametrów z użyciem 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}}'
Opis pól
Pole Typ Obowiązkowe Opis
offset int Liczba znalezionych subskrybentów z wynikowej listy, których należy pominąć. Potrzebne do możliwości porcjowego (stronicowanego) odczytu danych. Domyślnie — 0.
limit int Maksymalna liczba subskrybentów, którzy zostaną zwróceni w odpowiedzi na to żądanie. Potrzebne do możliwości porcjowego (stronicowanego) odczytu danych. Domyślnie — 50, maksymalnie — 1000.
Id int Identyfikator subskrybenta. Jeśli podany — używany jest jako filtr.
BaseId int Identyfikator bazy subskrybentów. Jeśli podany — używany jest jako filtr.
ClientUserId string ID subskrybenta w systemie klienta. Jeśli podany — używany jest jako filtr.
Email string Email subskrybenta. Jeśli podany — używany jest jako filtr.
IsActive int Flaga aktywności subskrybenta. Jeśli podana — używana jest jako filtr. Wskaż 0, aby wyszukać nieaktywnych subskrybentów, oraz 1 — aby aktywnych.
FirstName string Imię subskrybenta. Jeśli podane — używane jest jako filtr.
LastName string Nazwisko subskrybenta. Jeśli podane — używane jest jako filtr.
Gender string Płeć subskrybenta. Jeśli podana — używana jest jako filtr. Możliwe wartości: "male" — męska, "female" — żeńska, pusty ciąg znaków — wartość «Nie podano».
Przykład pomyślnej odpowiedzi w formacie JSON
{
    "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"
            }
        ]
    }
}

W tej odpowiedzi pole SubscribersList.TotalCount oznacza całkowitą liczbę subskrybentów znalezionych według żądania. Pola SubscribersList.Offset i SubscribersList.Limit powielają wartości z żądania z uwzględnieniem ograniczeń wartości minimalnych i maksymalnych. Pole SubscribersList.Subscribers zawiera tablicę subskrybentów.