Contactos: búsqueda

Contar contactos

Cuenta los contactos que cumplen un where, sin traerlos. Úsalo para mostrar "1.834 personas recibirán esto" antes de un envío.

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

Necesita el scope contact:read en tu API key.

Argumentos

  • whereobjectopcional

    El mismo where que Query Contacts. Omítelo para contar todos los contactos.

  • maxnumberopcional

    Deja de contar en este número, de 1 a 1.000.000. Por defecto, 100.000.

Inicio 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);

Respuesta

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

Campos de la respuesta

  • count

    Cuántos contactos coincidieron.

  • exact

    false cuando el conteo se detuvo antes, en max o en el límite de tiempo de la petición. El número real es entonces al menos count.

Totales sin contar

Para totales por estado, lista o etiqueta, Get Stats es más barato: lee contadores que se actualizan con cada cambio, en lugar de recorrer los contactos.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401INVALID_API_KEY

    La API key no existe, se revocó o se desactivó en el dashboard.

  • 429RATE_LIMITED

    Más de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.

  • CMDMISSING_SCOPE

    La API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.