Recibir correos: Contactos y público

Contar contactos

Cuenta los contactos que cumplen un filtro. Solo lectura.

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

Argumentos

  • whereobjectopcional

    Filtros: estado, etiquetas, dominio, aperturas y clics, fechas y campos personalizados. Mismo formato que los contactos del dashboard.

  • maxnumberopcional

    Deja de contar en este número, hasta 100.000. Por defecto 10.000.

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

Respuesta

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

Campos de la respuesta

  • count

    Cuántos contactos coincidieron.

  • exact

    false cuando el conteo se detuvo en max.

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.

  • 401TOKEN_EXPIRED

    El access token expiró. Llama a Refresh Token y repite la solicitud.

  • 401INVALID_TOKEN

    El token está mal formado, es desconocido o fue revocado.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 en curso para la misma IP + buzón. Espera la cantidad de segundos indicada en Retry-After.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido.

  • CMDINTERNAL

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