Pāriet uz dokumentāciju
API

Uzskaitīt un iegūt

Atrodiet ziņojumus un redziet, kas ar vienu noticis.

GETapi.openemail.uk/emails

Izpilda jebkuru no 3 izsaukumiem šajā lapā pret jūsu darbvietu, ar jūsu paša atslēgu.

Uzskaitīšana

GET /emails, jaunākie pa priekšu. Filtrējiet ar status (atdalīts ar komatiem) un from. Lapošana ir keyset, nevis nobīdes: nododiet nextCursor, ko saņēmāt. Nobīdes lapošana klusi izlaiž rindas, kad lapošanas laikā pienāk jauni ziņojumi.

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

Rinda, kas tika izsekota, nes arī kompaktu tracking objektu: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Rindai, kas netika izsekota, nav nekādas tracking atslēgas: openCount: 0 uz ziņojuma, kurā nekad nebija piksela, lasītos kā “neviens to neatvēra”, un tādu apgalvojumu mēs nevaram izteikt.

Viena iegūšana

GET /emails/{id} atgriež ziņojumu ar piegādes stāvokli katram saņēmējam un PILNU izsekošanas atskaiti, nevis saraksta kopsavilkumu, jo viena iegūšana var atļauties sadalījumu pa saņēmējiem un saites. Id, kas neeksistē, ir 404, nekad izdomāti veiksmīga atbilde.

Saņēmēja statussNozīme
pendingVēl nav pārraidīts.
deliveredNodots transportam šai adresei.
failedTransports to noraidīja.
uncertainTransports pusceļā neizdevās un nevar pateikt, kurus saņēmējus tas sasniedza. Tiek rādīts kā tāds, nevis uzminēts kādā no pusēm.

Notikumi

GET /emails/{id}/events atgriež pēdas, vecākās pa priekšu: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled un, uz izsekota ziņojuma, email.opened, email.clicked un email.downloaded, tiklīdz tie notiek. Lai jums pateiktu, nevis jūs tos aptaujātu, reģistrējiet webhook.