Tracking Preferences: Membaca

Ambil banyak

Preferensi hingga 100 penerima dalam satu perintah. Gunakan tepat sebelum pengiriman untuk menentukan track_opens dan track_clicks per penerima.

POSThttps://g.sendcorex.com/v1/privacycommand: get_many
i

Membutuhkan scope privacy:read pada API key Anda.

i

Hanya penerima yang punya preferensi yang dikembalikan. Alamat yang tidak ada di jawaban belum pernah memilih apa pun.

Argumen

  • emailsstring[]wajib

    1 hingga 100 alamat penerima. Duplikat dan alamat tidak valid diabaikan.

    mis. ["jane.doe@example.com", "marc.dupont@example.fr", "new.person@example.com"]

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "get_many",
        args: {
          emails: [
            "jane.doe@example.com",
            "marc.dupont@example.fr",
            "new.person@example.com"
          ]
        }
      }
    ]
  },
  { 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);

Respons

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_many",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "preferences": [
          {
            "email": "jane.doe@example.com",
            "track_opens": false,
            "track_clicks": true,
            "source": "page",
            "updated_at": "2026-10-24T07:20:12.031Z"
          },
          {
            "email": "marc.dupont@example.fr",
            "track_opens": false,
            "track_clicks": false,
            "source": "api",
            "updated_at": "2026-10-24T07:41:55.508Z"
          }
        ]
      }
    }
  ]
}

Field respons

  • preferences

    Satu entri per penerima yang punya preferensi.

  • preferences[].email

    Alamat penerima, dalam huruf kecil.

  • preferences[].track_opens

    true penerima mengizinkan pelacakan open, false menolaknya, null belum pernah memilih.

  • preferences[].track_clicks

    true penerima mengizinkan pelacakan klik, false menolaknya, null belum pernah memilih.

  • preferences[].source

    Siapa yang melakukan perubahan: page (penerima, di halaman preferensi tracking), api (Anda, dengan Set Preferences), atau dashboard.

  • preferences[].updated_at

    Kapan perubahan dilakukan. ISO 8601, UTC.

Sebelum mengirim

Baca batch-nya, lalu kirim ke setiap penerima dengan tracking yang mereka izinkan. Penerima tanpa preferensi mengikuti default Anda.

Node.js

const [r] = await call({ command: 'get_many', args: { emails: batch.map((x) => x.email) } });
const prefs = new Map(r.data.preferences.map((p) => [p.email, p]));

for (const x of batch) {
  const p = prefs.get(x.email.toLowerCase());
  await send({
    to: x.email,
    unsubscribe: true,
    track_opens: p?.track_opens === true,   // opt-in: only when allowed
    track_clicks: p?.track_clicks === true,
  });
}
i

Anda tidak perlu melakukan ini untuk menghormati penolakan: dengan "unsubscribe": true, penerima yang mematikan tracking tidak pernah dilacak. Ini untuk aturan opt-in, di mana tracking harus tetap mati sampai penerima mengizinkannya.

Jawabannya

data

{
  "preferences": [
    {
      "email": "jane.doe@example.com",
      "track_opens": false,
      "track_clicks": true,
      "source": "page",
      "updated_at": "2026-10-24T07:20:12.031Z"
    },
    {
      "email": "marc.dupont@example.fr",
      "track_opens": false,
      "track_clicks": false,
      "source": "api",
      "updated_at": "2026-10-24T07:41:55.508Z"
    }
  ]
}

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401INVALID_API_KEY

    API key tidak ada, telah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

    Lebih dari 15 request/dtk atau 15 bersamaan untuk IP + API key yang sama. Tunggu sejumlah detik yang ada di Retry-After.

  • CMDMISSING_SCOPE

    API key tidak memiliki scope perintah ini (`privacy:read` untuk membaca, `privacy:write` untuk mengubah).

  • CMDINVALID_ARGS

    Ada argumen yang tidak valid: `email` tidak ada atau salah format, lebih dari 100 `emails`, `track_opens` yang bukan `true`/`false`, limit di luar rentang…

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.