O método é destinado à obtenção da lista de bloqueios (Suppressions). 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.
Bloqueio (Suppression, regra de bloqueio) — é uma funcionalidade do site que impede o envio de e-mails para um determinado endereço. Por exemplo, o usuário cancelou a assinatura / reclamou de spam ou o seu endereço de e-mail simplesmente não funciona. O sistema identifica a situação em que o envio de e-mails para este email já não é possível e cria uma regra de bloqueio.
Requisição HTTP
- URL:
https://sender-solutions.com/api/suppressions/suppressions-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/suppressions/suppressions-list/?offset=0&limit=10&Id=25&BaseId=0&Email=username%40example.com&Type=unsubscribe' \
--header 'Authorization: {{api-token}}'
Descrição dos campos
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
offset | int | Quantidade de registros encontrados na lista final que devem ser pulados. Necessário para a implementação da leitura em porções (por páginas) dos dados. Por padrão — 0. | |
limit | int | Quantidade máxima de registros que devem ser retornados na resposta a esta requisição. Necessário para a implementação da leitura em porções (por páginas) dos dados. Por padrão — 100, máximo — 2000. | |
Id | int | Identificador da regra de bloqueio. Se indicado, é usado como filtro. | |
BaseId | int | Identificador da base de assinantes. Se indicado, é usado como filtro. O valor 0 significa todas as bases, ou seja, a regra não está limitada a nenhuma base específica. Ao indicar o valor 0, a filtragem ainda é realizada. Para não filtrar o resultado pelo campo BaseId, é necessário não transmitir este campo de forma alguma. | |
Email | string | Endereço de e-mail. Se indicado, é usado como filtro. | |
Type | string | Tipo da regra. Se indicado, é usado como filtro. Valores possíveis: spam — reclamação de spam, unsubscribe — cancelamento de assinatura do envio, hard_bounce — erros permanentes de entrega, soft_bounces — erros temporários de entrega que se repetiram muitas vezes. |
Exemplo de resposta bem-sucedida no formato JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}Nesta resposta, o campo SuppressionsList.TotalCount significa a quantidade total de registros encontrados pela requisição. Os campos SuppressionsList.Offset e SuppressionsList.Limit duplicam os valores da requisição levando em conta as limitações de valores mínimos e máximos. O campo SuppressionsList.Suppressions contém o array de regras de bloqueio. O campo SuppressionsList.Suppressions.*.CreatedAt corresponde ao horário de criação da regra no formato UnixTimestamp.