Sender Solutions | Obtenção da lista de assinantes por meio da API

5. Obtenção da lista de assinantes por meio da API

O método é destinado à obtenção da lista de Assinantes. Pode ser usado para a busca por um determinado conjunto de filtros. Todos os parâmetros são opcionais. Os dados são transmitidos nos parâmetros query no link.

Requisição HTTP

URL: https://sender-solutions.com/api/subscribers/subscribers-list/
Método HTTP: GET

Exemplo de requisição com o 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}}'

Descrição dos campos

Campo	Tipo	Descrição
`offset`	int	Quantidade de assinantes encontrados na lista final que devem ser pulados. Necessário para a possibilidade de leitura em porções (por páginas) dos dados. Por padrão — 0.
`limit`	int	Quantidade máxima de assinantes que serão retornados na resposta a esta requisição. Necessário para a possibilidade de leitura em porções (por páginas) dos dados. Por padrão — 50, máximo — 1000.
`Id`	int	Identificador do assinante. Se indicado — é usado como filtro.
`BaseId`	int	Identificador da base de assinantes. Se indicado — é usado como filtro.
`ClientUserId`	string	ID do assinante no sistema do cliente. Se indicado — é usado como filtro.
`Email`	string	Email do assinante. Se indicado — é usado como filtro.
`IsActive`	int	Indicador de atividade do assinante. Se indicado — é usado como filtro. Indique 0 para buscar assinantes inativos e 1 — para ativos.
`FirstName`	string	Nome do assinante. Se indicado — é usado como filtro.
`LastName`	string	Sobrenome do assinante. Se indicado — é usado como filtro.
`Gender`	string	Sexo do assinante. Se indicado — é usado como filtro. Valores possíveis: `"male"` — masculino, `"female"` — feminino, string vazia — valor «Não indicado».

Exemplo de resposta bem-sucedida no 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"
            }
        ]
    }
}

Nesta resposta, o campo SubscribersList.TotalCount significa a quantidade total de assinantes encontrados pela requisição. Os campos SubscribersList.Offset e SubscribersList.Limit duplicam os valores da requisição levando em conta as limitações de valores mínimos e máximos. O campo SubscribersList.Subscribers contém o array de assinantes.