Kalo te dokumentacioni
API

Listimi dhe marrja

Gjeni mesazhe dhe shihni ç’u bë me njërin.

GETapi.openemail.uk/emails

Ekzekuton cilëndo nga 3 thirrjet e kësaj faqeje kundrejt hapësirës suaj të punës, me çelësin tuaj.

Listimi

GET /emails, më të rejat të parat. Filtroni me status (të ndarë me presje) dhe from. Faqosja bëhet me çelës (keyset) e jo me offset: ktheni pas nextCursor që ju është dhënë. Faqosja me offset i kapërcen rreshtat në heshtje kur mbërrijnë mesazhe të reja ndërsa po shfletoni.

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

Një rresht që është gjurmuar mbart edhe një objekt kompakt tracking: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Një rresht që nuk është gjurmuar nuk mbart fare një çelës tracking: openCount: 0 te një mesazh që nuk pati kurrë piksel lexohet si «askush nuk e hapi», pohim që ne nuk jemi në gjendje ta bëjmë.

Marrja e njërit

GET /emails/{id} e kthen mesazhin me gjendjen e dërgesës për secilin marrës dhe me raportin E PLOTË të gjurmimit në vend të përmbledhjes së listës, sepse një marrje e vetme mund ta përballojë ndarjen sipas marrësit dhe lidhjet. Një id që nuk ekziston është një 404, kurrë një sukses i sajuar.

Statusi i marrësitDo të thotë
pendingEnde i patransmetuar.
deliveredI dorëzuar te transporti për këtë adresë.
failedTransporti e refuzoi.
uncertainNjë transport dështoi në mes të rrugës dhe nuk mund të thotë cilët marrës arriti. Shfaqet si i tillë, në vend që të hamendësohet në njërën anë a në tjetrën.

Ngjarjet

GET /emails/{id}/events e kthen gjurmën, më të vjetrat të parat: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled, dhe, te një mesazh i gjurmuar, email.opened, email.clicked e email.downloaded sapo ndodhin. Për t’u njoftuar në vend që t’i kërkoni vazhdimisht, regjistroni një webhook.