Belgelere geç
API

Gönderim şeritlerini listeleme

Postanın ilerlediği iki şerit, geri dönüş ve şikâyet sayılarıyla birlikte.

GET/sending/streams

2 çağrıdan herhangi birini çalışma alanınızda çalıştırır.

GET /sending/streams

Postanın ilerlediği iki şerit, geri dönüş ve şikâyet sayılarıyla birlikte.

Örnek

emails:read gerektirir. Posta, kendi kuyrukları ve kendi itibarı olan iki şeritte ilerler: parola sıfırlamaları ve makbuzlar gibi uygulama postası için transactional, bültenler için broadcast. Her şerit, son 7 günün sayılarıyla ve toplu gönderim şeridinin bağlı olduğu limits ile birlikte gelir.

curl
curl "$OE/sending/streams" -H "$AUTH"
Yanıt
{ "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 }}] }

Toplu gönderim şeridi, minimumRecipients değerine ulaştıktan sonra bu 7 gün içinde geri dönüş oranı %4'ü ya da şikâyet oranı %0,2'yi geçtiğinde kendini duraklatır. pausedReason hangisi olduğunu söyler, çalışma alanı sahibi bir e-posta alır ve uygulama postası gitmeye devam eder.

Duraklatılmışken, stream değeri broadcast olan bir ileti ve yeni bir toplu gönderim 409 stream_paused döndürür; gönderilmekte olan toplu gönderimler ise bekletilir.

Şerit seçme

emails:send gerektirir. POST /emails içinde, POST /emails/batch isteğinin her iletisinde ve POST /templates/{id}/send içinde stream şeridi seçer. Aksini belirtmediğiniz sürece transactional olur ve bir toplu gönderimin her kopyası broadcast üzerinden gider.

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" }'
Yanıt
{ "object": "email", "id": "msg_5f1c9a0e7b2d4c6a8e3f1b7d", "status": "queued", "stream": "broadcast" }

SMTP üzerinden X-OpenEmail-Stream: broadcast üstbilgisi aynı işi görür ve ileti gönderilmeden önce kaldırılır.

Duraklatılmış bir şeridi sürdürme

domains:write ve çalışma alanı sahibi gerekir. POST /sending/streams/broadcast/resume şeridi sürdürür: bekletilen iletiler hemen gönderilir ve 7 günlük sayım şimdiden yeniden başlar, bu yüzden önce kitleyi temizleyin.

curl
curl -X POST "$OE/sending/streams/broadcast/resume" -H "$AUTH"
Yanıt
{  "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 }}

Duraklatılmamış bir şerit 409 stream_not_paused döndürür.

Bir OAuth erişim tokenı bu çağrı için bir doğrulama kodu gerektirir. Uygulama son 60 dakika içinde bir kod doğrulayana kadar çağrı 403 step_up_required yanıtını verir ve hiçbir şeyi değiştirmez. Bir API anahtarından asla istenmez. Kimlik doğrulama sayfası bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.

Referans