Recevoir des emails : Contacts et audience

Voir l’audience

Vérifie une audience avant l’envoi : combien de personnes et les 30 premières. Lecture seule.

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

Les personnes désinscrites sont toujours exclues.

i

Disponible avec les offres payantes.

Arguments

  • segmentstringobligatoire

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

Démarrage rapide

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

Réponse

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

Champs de la réponse

  • segment

    L’audience demandée.

  • emails

    Les 30 premières adresses.

  • total

    Combien de personnes le recevront.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDINVALID_AUDIENCE

    L’audience n’est pas valide : groupe inconnu, segment d’une autre boîte ou message non envoyé par cette boîte.

  • CMDPAID_PLAN_REQUIRED

    Plusieurs adresses dans `to` nécessitent une offre payante.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.