1. Ayuda
  2. Cómo trabajar por API con sender-solutions.com
  3. 5. Obtención de la lista de suscriptores mediante la API

5. Obtención de la lista de suscriptores mediante la API

5. Obtención de la lista de suscriptores mediante la API

El método está destinado a la obtención de la lista de Suscriptores. Se puede usar para buscar según un conjunto determinado de filtros. Todos los parámetros son opcionales. Los datos se transmiten en los parámetros query del enlace.

Solicitud HTTP
  • URL: https://sender-solutions.com/api/subscribers/subscribers-list/
  • Método HTTP: GET
Ejemplo de solicitud con el conjunto máximo de parámetros usando 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}}'
Descripción de los campos
Campo Tipo Obligatorio Descripción
offset int Cantidad de suscriptores encontrados de la lista resultante que es necesario omitir. Se necesita para la posibilidad de lectura por porciones (por páginas) de los datos. Por defecto — 0.
limit int Cantidad máxima de suscriptores que se devolverán en la respuesta a esta solicitud. Se necesita para la posibilidad de lectura por porciones (por páginas) de los datos. Por defecto — 50, máximo — 1000.
Id int Identificador del suscriptor. Si se indica — se usa como filtro.
BaseId int Identificador de la base de suscriptores. Si se indica — se usa como filtro.
ClientUserId string ID del suscriptor en el sistema del cliente. Si se indica — se usa como filtro.
Email string Email del suscriptor. Si se indica — se usa como filtro.
IsActive int Indicador de actividad del suscriptor. Si se indica — se usa como filtro. Indique 0 para buscar suscriptores inactivos y 1 — para activos.
FirstName string Nombre del suscriptor. Si se indica — se usa como filtro.
LastName string Apellido del suscriptor. Si se indica — se usa como filtro.
Gender string Sexo del suscriptor. Si se indica — se usa como filtro. Valores posibles: "male" — masculino, "female" — femenino, cadena vacía — valor «No indicado».
Ejemplo de respuesta exitosa en formato 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"
            }
        ]
    }
}

En esta respuesta, el campo SubscribersList.TotalCount significa la cantidad total de suscriptores encontrados según la solicitud. Los campos SubscribersList.Offset y SubscribersList.Limit duplican los valores de la solicitud teniendo en cuenta las restricciones de los valores mínimos y máximos. El campo SubscribersList.Subscribers contiene un array de suscriptores.