Receber emails: Contatos e público

Contar contatos

Conta os contatos que batem com um filtro. Só leitura.

POSThttps://g.sendcorex.com/v1command: count_contacts

Argumentos

  • whereobjectopcional

    Filtros: status, tags, domínio, aberturas e cliques, datas e campos personalizados. Mesmo formato dos contatos do dashboard.

  • maxnumberopcional

    Para de contar neste número, até 100.000. Padrão 10.000.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "count_contacts",
        args: {
          where: {
            status: "subscribed"
          }
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "count_contacts",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "count": 1240,
        "exact": true
      }
    }
  ]
}

Campos da resposta

  • count

    Quantos contatos bateram.

  • exact

    false quando a contagem parou em max.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.