API

Bir toplu gönderimi getir

Kopyalarından canlı okunan `counts` ile tek bir toplu gönderim; bu da gönderim sürerken yoklanacak çağrının bu olmasını sağlar.

GETapi.openemail.uk/broadcasts/{id}

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

GET /broadcasts/{id}

Kopyalarından canlı okunan counts ile tek bir toplu gönderim; bu da gönderim sürerken yoklanacak çağrının bu olmasını sağlar.

Örnek

emails:read gerekir.

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b" -H "$AUTH"

Yanıt

{  "object": "broadcast",  "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "status": "sending",  "mode": "live",  "source": "api",  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],  "from": "Acme <[email protected]>",  "subject": "{{firstName|Hello}}, the September release is out",  "counts": {    "recipients": 412,    "created": 250,    "skipped": 1,    "failedToQueue": 0,    "queued": 38,    "sending": 2,    "sent": 209,    "failed": 1,    "cancelled": 0  },  "lastError": null,  "scheduledAt": null,  "startedAt": "2026-09-23T12:00:02.000Z",  "completedAt": null,  "cancelledAt": null,  "createdAt": "2026-09-23T12:00:00.000Z",  "updatedAt": "2026-09-23T12:00:41.000Z"}

Başka bir çalışma alanından bir kimlik 404 broadcast_not_found olur.

Her kopyanın kime gittiğini ve ona ne olduğunu görmek için kopyaları GET /emails?broadcastId= ile listeleyin ve birini GET /emails/{id} ile okuyun.

Durumlar

Durum	Anlamı
scheduled	`scheduledAt` bekleniyor.
queued	Gönderimin başlaması bekleniyor.
sending	Kitleleri dolaşıyor ya da dolaşmayı bitirdi ama kopyalar hâlâ gitmeyi bekliyor. Son kişiye ulaşıldığı anda `completedAt` ayarlanır.
sent	Teslim edilen her kopya gitti ya da başarısız oldu.
cancelled	`POST /broadcasts/{id}/cancel` ile durduruldu.
failed	Toplu gönderimin tamamı durdu: `from` adresinden artık gönderilemiyor, şablon çözümlenmeyi bıraktı, plan yarı yolda bitti, gönderimin kendisi sürekli başarısız oldu ya da tek bir kopya bile yazılamadı. Hangisi olduğunu `lastError` söyler.

Sayaçlar

Sayaç	Anlamı
recipients	Toplu gönderim oluşturulurken alınan tahmin. Sonrasında değişmez.
created	Şimdiye kadar yazılan kopyalar, ulaşılan her kişi için bir tane.
skipped	Gönderim onlara ulaştığında adresleri engellenmiş olduğu için atlanan kişiler.
failedToQueue	Kopyası yazılamayan kişiler. En yenisini `lastError` adlandırır.
queued, sending, sent, failed, cancelled	Kopyalar, her birinin şu anki durumuna göre, canlı sayılır.