Recibir correos: Contactos y público

Ver público

Revisa un público antes de enviar: cuántas personas y las 30 primeras. Solo lectura.

POSThttps://g.sendcorex.com/v1command: get_audience
i

Quienes se dieron de baja siempre quedan fuera.

i

Disponible en los planes de pago.

Argumentos

  • segmentstringobligatorio

    subscribed, opened, clicked, both, seg:<segment_id> o msg:<message_uid>:opened|clicked|not_opened.

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_audience",
        args: {
          segment: "opened"
        }
      }
    ]
  },
  { 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": "get_audience",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "segment": "opened",
        "emails": [
          "ana@empresa.com"
        ],
        "total": 1240
      }
    }
  ]
}

Campos de la respuesta

  • segment

    El público solicitado.

  • emails

    Las 30 primeras direcciones.

  • total

    Cuántas personas lo recibirán.

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_AUDIENCE

    El público no es válido: grupo desconocido, segmento de otro buzón o mensaje que este buzón no envió.

  • CMDPAID_PLAN_REQUIRED

    Más de una dirección en `to` requiere un plan de pago.

  • CMDINTERNAL

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