Belgelere geç
API

Listeleme ve getirme

İletileri bulun ve birinin başına ne geldiğini görün.

GETapi.openemail.uk/emails

Bu sayfadaki 3 çağrının herhangi birini kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

Listeleme

GET /emails, en yeniden eskiye. status (virgülle ayrılmış) ve from ile filtreleyin. Sayfalama offset değil keyset tabanlıdır: size verilen nextCursor değerini geri gönderin. Offset ile sayfalama, siz sayfaları gezerken yeni iletiler geldiğinde satırları sessizce atlar.

GET /emails?status=failed&limit=10
{ "object": "list", "data": [], "hasMore": true, "nextCursor": "msg_01j8…" }

İzlenen bir satır ayrıca derli toplu bir tracking nesnesi taşır: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. İzlenmeyen bir satırda hiç tracking anahtarı bulunmaz: hiç piksel taşımamış bir iletideki openCount: 0 değeri "kimse açmadı" diye okunur ve bu, ileri sürecek konumda olmadığımız bir iddiadır.

Tek bir iletiyi getirme

GET /emails/{id}, iletiyi alıcı bazında teslim durumuyla ve liste özeti yerine TAM izleme raporuyla döndürür; çünkü tek bir getirme, alıcı bazında dökümü ve bağlantıları kaldırabilir. Var olmayan bir id 404 verir, asla uydurulmuş bir başarı değil.

Alıcı durumuAnlamı
pendingHenüz iletilmedi.
deliveredBu adres için taşıyıcıya teslim edildi.
failedTaşıyıcı reddetti.
uncertainBir taşıyıcı yol ortasında başarısız oldu ve hangi alıcılara ulaştığını söyleyemiyor. İki yönde de tahmin yürütülmeden olduğu gibi gösterilir.

Olaylar

GET /emails/{id}/events izi eskiden yeniye döndürür: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled ve izlenen bir iletide gerçekleştikçe email.opened, email.clicked ve email.downloaded. Bunlar için yoklama yapmak yerine haber almak istiyorsanız bir webhook kaydedin.