Ves a la documentació
API

Llistar i recuperar

Trobeu missatges i vegeu què n'ha estat d'un.

GETapi.openemail.uk/emails

Executa qualsevol de les 3 crides d'aquesta pàgina contra el teu espai de treball, amb la teva pròpia clau.

Llistat

GET /emails, els més nous primer. Filtreu amb status (separats per comes) i from. La paginació és per clau, no per offset: passeu el nextCursor que us hagin donat. La paginació per offset es deixa files en silenci quan arriben missatges nous mentre pagineu.

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

Una fila amb seguiment porta també un objecte tracking compacte: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Una fila sense seguiment no porta cap clau tracking: un openCount: 0 en un missatge que mai no ha dut cap píxel es llegeix com a «ningú no l'ha obert», una afirmació que no estem en posició de fer.

Recuperar-ne un

GET /emails/{id} retorna el missatge amb l'estat de lliurament per destinatari, i l'informe de seguiment COMPLET en lloc del resum de la llista, perquè una sola recuperació es pot permetre el desglossament per destinatari i els enllaços. Un id que no existeix és un 404, mai un èxit inventat.

Estat del destinatariSignifica
pendingEncara no s'ha transmès.
deliveredLliurat al transport per a aquesta adreça.
failedEl transport l'ha rebutjat.
uncertainUn transport ha fallat a mig camí i no pot dir a quins destinataris ha arribat. Es mostra tal com és, en lloc d'endevinar-ho en un sentit o l'altre.

Esdeveniments

GET /emails/{id}/events retorna el rastre, els més antics primer: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled i, en un missatge amb seguiment, email.opened, email.clicked i email.downloaded a mesura que van passant. Perquè us ho comuniquin en lloc d'haver-ho de consultar, registreu un webhook.