Receber emails: Contatos e público

Ver público

Confere um público antes de enviar: quantas pessoas e as 30 primeiras. Só leitura.

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

Quem se descadastrou sempre fica de fora.

i

Disponível nos planos pagos.

Argumentos

  • segmentstringobrigatório

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

Início 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);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_audience",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "segment": "opened",
        "emails": [
          "ana@empresa.com"
        ],
        "total": 1240
      }
    }
  ]
}

Campos da resposta

  • segment

    O público pedido.

  • emails

    Os 30 primeiros endereços.

  • total

    Quantas pessoas vão receber.

Erros

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

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINVALID_AUDIENCE

    O público não é válido: grupo desconhecido, segmento de outra caixa ou mensagem que esta caixa não enviou.

  • CMDPAID_PLAN_REQUIRED

    Mais de um endereço em `to` exige um plano pago.

  • CMDINTERNAL

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