Contatos: busca

Contar contatos

Conte os contatos que correspondem a um where, sem trazê-los. Use para mostrar "1.834 pessoas vão receber isto" antes de um envio.

POSThttps://g.sendcorex.com/v1/contactscommand: count_contacts
i

Precisa do scope contact:read na sua API key.

Argumentos

  • whereobjectopcional

    O mesmo where de Query Contacts. Omita para contar todos os contatos.

  • maxnumberopcional

    Para de contar neste número, de 1 a 1.000.000. Padrão: 100.000.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "count_contacts",
        args: {
          where: {
            list: "customers",
            sendable: true
          }
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

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",
      "took_ms": 14,
      "data": {
        "count": 1790,
        "exact": true
      }
    }
  ]
}

Campos da resposta

  • count

    Quantos contatos corresponderam.

  • exact

    false quando a contagem parou antes, em max ou no limite de tempo do request. O número real é então pelo menos count.

Totais sem contar

Para totais por status, lista ou tag, Get Stats é mais barato: ele lê contadores atualizados a cada alteração, em vez de percorrer os contatos.

Erros

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

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.

  • CMDINVALID_ARGS

    Um argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…

  • CMDINTERNAL

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