API

Merr një transmetim

Një transmetim me `counts` të lexuara drejtpërdrejt nga kopjet e tij, gjë që e bën këtë thirrjen për ta pyetur ndërsa dërgon.

GETapi.openemail.uk/broadcasts/{id}

Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.

GET /broadcasts/{id}

Një transmetim me counts të lexuara drejtpërdrejt nga kopjet e tij, gjë që e bën këtë thirrjen për ta pyetur ndërsa dërgon.

Shembull

Kërkon emails:read.

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b" -H "$AUTH"

Përgjigje

{  "object": "broadcast",  "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "status": "sending",  "mode": "live",  "source": "api",  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],  "from": "Acme <[email protected]>",  "subject": "{{firstName|Hello}}, the September release is out",  "counts": {    "recipients": 412,    "created": 250,    "skipped": 1,    "failedToQueue": 0,    "queued": 38,    "sending": 2,    "sent": 209,    "failed": 1,    "cancelled": 0  },  "lastError": null,  "scheduledAt": null,  "startedAt": "2026-09-23T12:00:02.000Z",  "completedAt": null,  "cancelledAt": null,  "createdAt": "2026-09-23T12:00:00.000Z",  "updatedAt": "2026-09-23T12:00:41.000Z"}

Një id nga një hapësirë tjetër pune është 404 broadcast_not_found.

Për të parë kujt i shkoi çdo kopje dhe çfarë ndodhi me të, listoni kopjet me GET /emails?broadcastId= dhe lexoni njërën me GET /emails/{id}.

Gjendjet

Statusi	Kuptimi
scheduled	Pret `scheduledAt`.
queued	Pret që të nisë dërgimi.
sending	Po kalon audiencat, ose ka mbaruar së kaluari ndërsa kopjet ende presin të dalin. `completedAt` vendoset sapo arrihet personi i fundit.
sent	Çdo kopje e dorëzuar ka dalë ose ka dështuar.
cancelled	U ndal nga `POST /broadcasts/{id}/cancel`.
failed	I gjithë transmetimi u ndal: nga adresa `from` nuk mund të dërgohet më, shablloni pushoi së zgjidhuri, plani mbaroi në mes të rrugës, vetë dërgimi vazhdoi të dështonte, ose nuk u shkrua dot asnjë kopje. `lastError` tregon cila.

Numëruesit

Numëruesi	Kuptimi
recipients	Vlerësimi i marrë kur u krijua transmetimi. Nuk ndryshon më pas.
created	Kopjet e shkruara deri tani, një për çdo person të arritur.
skipped	Njerëz të kapërcyer sepse adresa e tyre ishte e bllokuar kur dërgimi i arriti.
failedToQueue	Njerëz kopja e të cilëve nuk u shkrua dot. `lastError` emërton më të fundit.
queued, sending, sent, failed, cancelled	Kopjet sipas gjendjes në të cilën është secila tani, të numëruara drejtpërdrejt.