Sender Solutions | API üzerinden abone listesini alma

5. API üzerinden abone listesini alma

Metot, Abonelerin listesini almak için tasarlanmıştır. Belirli bir filtre kümesine göre arama için kullanılabilir. Tüm parametreler isteğe bağlıdır. Veriler, bağlantıdaki query parametrelerinde iletilir.

HTTP isteği

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

Maksimum parametre kümesiyle cURL kullanılarak istek örneği


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}}'

Alanların açıklaması

Alan	Tür	Açıklama
`offset`	int	Nihai listeden bulunan ve atlanması gereken abone sayısı. Verilerin parçalı (sayfalı) okunması olanağı için gereklidir. Varsayılan olarak — 0.
`limit`	int	Bu isteğe yanıt olarak döndürülecek maksimum abone sayısı. Verilerin parçalı (sayfalı) okunması olanağı için gereklidir. Varsayılan olarak — 50, maksimum — 1000.
`Id`	int	Abonenin tanımlayıcısı. Belirtilirse — filtre olarak kullanılır.
`BaseId`	int	Abone tabanının tanımlayıcısı. Belirtilirse — filtre olarak kullanılır.
`ClientUserId`	string	Müşterinin sistemindeki abone ID'si. Belirtilirse — filtre olarak kullanılır.
`Email`	string	Abonenin Email'i. Belirtilirse — filtre olarak kullanılır.
`IsActive`	int	Abonenin etkinlik bayrağı. Belirtilirse — filtre olarak kullanılır. Etkin olmayan aboneleri aramak için 0, etkin olanlar için ise 1 belirtin.
`FirstName`	string	Abonenin adı. Belirtilirse — filtre olarak kullanılır.
`LastName`	string	Abonenin soyadı. Belirtilirse — filtre olarak kullanılır.
`Gender`	string	Abonenin cinsiyeti. Belirtilirse — filtre olarak kullanılır. Olası değerler: `"male"` — erkek, `"female"` — kadın, boş dize — «Belirtilmemiş» değeri.

JSON formatında başarılı yanıt örneği

{
    "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"
            }
        ]
    }
}

Bu yanıtta SubscribersList.TotalCount alanı, isteğe göre bulunan toplam abone sayısını ifade eder. SubscribersList.Offset ve SubscribersList.Limit alanları, minimum ve maksimum değer sınırlamalarını dikkate alarak istekteki değerleri yineler. SubscribersList.Subscribers alanı abone dizisini içerir.