Kalo te dokumentacioni
API

Listoni korsitë e dërgimit

Dy korsitë ku udhëton posta, me numrat e tyre të kthimeve dhe ankesave.

GET/sending/streams

Ekzekuton cilëndo nga 2 thirrjet në hapësirën tuaj të punës.

GET /sending/streams

Dy korsitë ku udhëton posta, me numrat e tyre të kthimeve dhe ankesave.

Shembull

Kërkon emails:read. Posta udhëton në dy korsi me radhët dhe reputacionin e tyre: transactional për postën e aplikacionit, si rivendosjet e fjalëkalimit dhe faturat, dhe broadcast për buletinet. Çdo korsi vjen me numrat e saj për 7 ditët e fundit dhe me limits që i vihen korsisë së dërgesave masive.

curl
curl "$OE/sending/streams" -H "$AUTH"
Përgjigje
{ "object": "list", "data": [{  "object": "sending_stream",  "stream": "broadcast",  "status": "active",  "pausedAt": null,  "pausedReason": null,  "resumedAt": null,  "window": {    "since": "2026-10-04T09:41:00.000Z",    "until": "2026-10-11T09:41:00.000Z",    "recipients": 18240,    "bounced": 212,    "complained": 9,    "bounceRate": 0.0116,    "complaintRate": 0.0005  },  "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}] }

Korsia e dërgesave masive pezullohet vetë kur shkalla e kthimeve kalon 4% ose shkalla e ankesave kalon 0,2% në ato 7 ditë, sapo të ketë arritur minimumRecipients. pausedReason tregon cilën, pronari i hapësirës së punës merr një email, dhe posta e aplikacionit vazhdon të dalë.

Ndërsa është e pezulluar, një mesazh i dërguar me stream të vendosur në broadcast dhe një dërgesë e re masive japin 409 stream_paused, kurse dërgesat masive që po dalin mbahen pezull.

Zgjidhni një korsi

Kërkon emails:send. stream te POST /emails, te çdo mesazh i POST /emails/batch dhe te POST /templates/{id}/send zgjedh korsinë. Është transactional nëse nuk thoni ndryshe, dhe çdo kopje e një dërgese masive udhëton në broadcast.

curl
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "from": "[email protected]", "to": "[email protected]", "subject": "What is new in October", "text": "Three things shipped this month.", "stream": "broadcast" }'
Përgjigje
{ "object": "email", "id": "msg_5f1c9a0e7b2d4c6a8e3f1b7d", "status": "queued", "stream": "broadcast" }

Përmes SMTP, kreu X-OpenEmail-Stream: broadcast bën të njëjtën gjë, dhe hiqet para se mesazhi të dalë.

Rifilloni një korsi të pezulluar

Kërkon domains:write dhe pronarin e hapësirës së punës. POST /sending/streams/broadcast/resume e rifillon korsinë: mesazhet e mbajtura dalin menjëherë dhe numërimi 7-ditor nis nga e para që tani, ndaj pastroni së pari audiencën.

curl
curl -X POST "$OE/sending/streams/broadcast/resume" -H "$AUTH"
Përgjigje
{  "object": "sending_stream",  "stream": "broadcast",  "status": "active",  "pausedAt": null,  "pausedReason": null,  "resumedAt": null,  "window": {    "since": "2026-10-04T09:41:00.000Z",    "until": "2026-10-11T09:41:00.000Z",    "recipients": 18240,    "bounced": 212,    "complained": 9,    "bounceRate": 0.0116,    "complaintRate": 0.0005  },  "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}

Një korsi që nuk është pezulluar jep 409 stream_not_paused.

Një token qasjeje OAuth ka nevojë për një kod verifikimi për këtë thirrje. Derisa aplikacioni të ketë verifikuar një në 60 minutat e fundit, thirrja përgjigjet me 403 step_up_required dhe nuk ndryshon asgjë. Një çelësi API nuk i kërkohet kurrë. Faqja Autentikimi tregon si të kërkoni një kod dhe ta verifikoni.

Referencë