Ga direct naar de documentatie
API

Opvragen en ophalen

Berichten vinden en zien wat er met een bericht is gebeurd.

GETapi.openemail.uk/emails

Voert elk van de 3 aanroepen op deze pagina uit op je workspace, met je eigen sleutel.

Een lijst opvragen

GET /emails, nieuwste eerst. Filter met status (komma-gescheiden) en from. Pagineren gaat op keyset, niet op offset: geef de nextCursor mee die je hebt gekregen. Pagineren op offset slaat stilletjes rijen over wanneer er nieuwe berichten binnenkomen terwijl je doorbladert.

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

Een rij die is getrackt draagt ook een compact tracking-object: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Een rij die dat niet was draagt helemaal geen tracking-veld: openCount: 0 op een bericht dat nooit een pixel bevatte leest als "niemand heeft het geopend", en die bewering kunnen wij onmogelijk doen.

Er één ophalen

GET /emails/{id} geeft het bericht terug met de bezorgstatus per ontvanger, en het VOLLEDIGE trackingrapport in plaats van de samenvatting uit de lijst, omdat één ophaalactie de uitsplitsing per ontvanger en de links kan dragen. Een id die niet bestaat levert een 404 op, nooit een verzonnen succes.

Status per ontvangerBetekent
pendingNog niet verzonden.
deliveredOvergedragen aan het transport voor dit adres.
failedHet transport heeft het geweigerd.
uncertainEen transport is halverwege mislukt en kan niet zeggen welke ontvangers het heeft bereikt. Wordt als zodanig getoond in plaats van naar één kant toe geraden.

Gebeurtenissen

GET /emails/{id}/events geeft het spoor terug, oudste eerst: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled, en, op een getrackt bericht, email.opened, email.clicked en email.downloaded zodra ze gebeuren. Registreer een webhook om het te horen in plaats van erop te pollen.