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.
https://g.sendcorex.com/v1/contactscommand: count_contactsNecesita el scope contact:read en tu API key.
Argumentos
whereobjectopcionalEl mismo
whereque Query Contacts. Omítelo para contar todos los contactos.maxnumberopcionalDeja 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
countCuántos contactos coincidieron.
exactfalsecuando el conteo se detuvo antes, enmaxo en el límite de tiempo de la petición. El número real es entonces al menoscount.
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.
- 401
INVALID_API_KEYLa API key no existe, se revocó o se desactivó en el dashboard.
- 429
RATE_LIMITEDMás de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.
- CMD
MISSING_SCOPELa API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.
- CMD
INVALID_ARGSFalta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…
- CMD
INTERNALError del servidor. El detalle solo se escribe en el log del servidor.