Sender Solutions | Obținerea listei de abonați prin API

5. Obținerea listei de abonați prin API

Metoda este destinată obținerii listei de Abonați. Poate fi folosită pentru căutarea după un anumit set de filtre. Toți parametrii sunt opționali. Datele se transmit în parametrii query din link.

Cerere HTTP

URL: https://sender-solutions.com/api/subscribers/subscribers-list/
Metodă HTTP: GET

Exemplu de cerere cu setul maxim de parametri cu folosirea 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}}'

Descrierea câmpurilor

Câmp	Tip	Descriere
`offset`	int	Numărul de abonați găsiți din lista finală care trebuie săriți. Necesar pentru posibilitatea citirii pe porțiuni (pe pagini) a datelor. Implicit — 0.
`limit`	int	Numărul maxim de abonați care vor fi returnați în răspunsul la această cerere. Necesar pentru posibilitatea citirii pe porțiuni (pe pagini) a datelor. Implicit — 50, maxim — 1000.
`Id`	int	Identificatorul abonatului. Dacă este indicat — se folosește ca filtru.
`BaseId`	int	Identificatorul bazei de abonați. Dacă este indicat — se folosește ca filtru.
`ClientUserId`	string	ID-ul abonatului în sistemul clientului. Dacă este indicat — se folosește ca filtru.
`Email`	string	Email-ul abonatului. Dacă este indicat — se folosește ca filtru.
`IsActive`	int	Indicatorul de activitate al abonatului. Dacă este indicat — se folosește ca filtru. Indicați 0 pentru căutarea abonaților inactivi și 1 — pentru cei activi.
`FirstName`	string	Prenumele abonatului. Dacă este indicat — se folosește ca filtru.
`LastName`	string	Numele de familie al abonatului. Dacă este indicat — se folosește ca filtru.
`Gender`	string	Sexul abonatului. Dacă este indicat — se folosește ca filtru. Valori posibile: `"male"` — masculin, `"female"` — feminin, șir gol — valoarea «Neindicat».

Exemplu de răspuns reușit în formatul 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"
            }
        ]
    }
}

În acest răspuns, câmpul SubscribersList.TotalCount înseamnă numărul total de abonați găsiți după cerere. Câmpurile SubscribersList.Offset și SubscribersList.Limit dublează valorile din cerere ținând cont de limitările valorilor minime și maxime. Câmpul SubscribersList.Subscribers conține array-ul de abonați.