1. Aide
  2. Comment travailler via l'API avec sender-solutions.com
  3. 5. Obtention de la liste des abonnés via l'API

5. Obtention de la liste des abonnés via l'API

5. Obtention de la liste des abonnés via l'API

La méthode est destinée à l'obtention de la liste des Abonnés. On peut l'utiliser pour rechercher selon un ensemble défini de filtres. Tous les paramètres sont optionnels. Les données sont transmises dans les paramètres query du lien.

Requête HTTP
  • URL : https://sender-solutions.com/api/subscribers/subscribers-list/
  • Méthode HTTP : GET
Exemple de requête avec l'ensemble maximal de paramètres à l'aide de 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}}'
Description des champs
Champ Type Obligatoire Description
offset int Nombre d'abonnés trouvés dans la liste résultante qu'il faut ignorer. Nécessaire pour la possibilité de lecture par portions (par pages) des données. Par défaut — 0.
limit int Nombre maximal d'abonnés qui seront renvoyés dans la réponse à cette requête. Nécessaire pour la possibilité de lecture par portions (par pages) des données. Par défaut — 50, maximum — 1000.
Id int Identifiant de l'abonné. S'il est indiqué — il est utilisé comme filtre.
BaseId int Identifiant de la base d'abonnés. S'il est indiqué — il est utilisé comme filtre.
ClientUserId string ID de l'abonné dans le système du client. S'il est indiqué — il est utilisé comme filtre.
Email string Email de l'abonné. S'il est indiqué — il est utilisé comme filtre.
IsActive int Indicateur d'activité de l'abonné. S'il est indiqué — il est utilisé comme filtre. Indiquez 0 pour rechercher les abonnés inactifs et 1 — pour les actifs.
FirstName string Prénom de l'abonné. S'il est indiqué — il est utilisé comme filtre.
LastName string Nom de famille de l'abonné. S'il est indiqué — il est utilisé comme filtre.
Gender string Sexe de l'abonné. S'il est indiqué — il est utilisé comme filtre. Valeurs possibles : "male" — masculin, "female" — féminin, chaîne vide — valeur «Non indiqué».
Exemple de réponse réussie au format 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"
            }
        ]
    }
}

Dans cette réponse, le champ SubscribersList.TotalCount indique le nombre total d'abonnés trouvés selon la requête. Les champs SubscribersList.Offset et SubscribersList.Limit reprennent les valeurs de la requête en tenant compte des restrictions sur les valeurs minimales et maximales. Le champ SubscribersList.Subscribers contient un tableau d'abonnés.