Zur Dokumentation springen
API

Die Empfänger eines Broadcasts auflisten

Alle, an die der Broadcast ging, eine Zeile pro Kopie, nach Adresse sortiert: die ID der Kopie, ihr Status, wann sie gesendet und zugestellt wurde, ob sie gebounct ist oder als Spam gemeldet wurde, wie oft sie geöffnet und geklickt wurde und ob sich die Person nach dem Versand abgemeldet hat.

GETapi.openemail.uk/broadcasts/{id}/recipients

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

GET /broadcasts/{id}/recipients

Alle, an die der Broadcast ging, eine Zeile pro Kopie, nach Adresse sortiert: die ID der Kopie, ihr Status, wann sie gesendet und zugestellt wurde, ob sie gebounct ist oder als Spam gemeldet wurde, wie oft sie geöffnet und geklickt wurde und ob sich die Person nach dem Versand abgemeldet hat.

Parameter

idstringerforderlich
Im Pfad. Eine `brd_`-ID aus `POST /broadcasts` oder `GET /broadcasts`.
filterstring
Behält eine Gruppe: `pending` (noch in der Warteschlange oder im Versand), `sent`, `delivered`, `opened`, `not_opened` (gesendet und nie geöffnet), `clicked`, `bounced`, `complained`, `failed` (fehlgeschlagen oder abgebrochen) oder `unsubscribed`.
qstring
Durchsucht Adresse und Name, ohne Groß- und Kleinschreibung zu beachten. Bis zu 200 Zeichen.
limitinteger
Zeilen pro Seite, 1 bis 200. Standardwert ist 50.
cursorstring
Der `nextCursor` der vorherigen Seite, unverändert zurückgegeben, mit demselben `filter` und `q`. Er hält fest, wo die letzte Zeile stand, sodass eine Zeile, die sich zwischen zwei Seiten ändert, den Durchlauf nie unterbricht.

Beispiel

Braucht emails:read. Die Antwort ist eine Seite mit broadcast_recipient-Zeilen.

curl
curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/recipients?filter=opened&limit=50" -H "$AUTH"
Antwort
{  "object": "list",  "data": [    {      "object": "broadcast_recipient",      "emailId": "msg_01dad25067bc4dac966d515d",      "contactId": "6f1c2a8e-3b4d-4e9f-a1c7-2d5e8b0f9a34",      "email": "[email protected]",      "name": "Ada Lovelace",      "status": "sent",      "sentAt": "2026-09-23T12:00:09.000Z",      "deliveredAt": "2026-09-23T12:00:11.000Z",      "bouncedAt": null,      "complainedAt": null,      "failure": null,      "opens": 3,      "firstOpenAt": "2026-09-23T12:14:30.000Z",      "clicks": 1,      "firstClickAt": "2026-09-23T12:15:02.000Z",      "unsubscribedAt": null    }  ],  "hasMore": true,  "nextCursor": "WyJhZGFAZXhhbXBsZS5jb20iLCJtc2dfMDFkYWQyNTA2N2JjNGRhYzk2NmQ1MTVkIl0"}

Öffnungen und Klicks lassen Bild-Proxys und Link-Scanner außen vor und bleiben 0, wenn der Broadcast mit ausgeschaltetem Tracking gesendet wurde.

status ist der Zustand der Kopie im Versandprotokoll: queued, scheduled, sending, sent, failed oder cancelled. deliveredAt, bouncedAt und complainedAt sind das erste email.delivered, email.bounced und email.complained für sie, und failure sagt, warum eine Kopie fehlgeschlagen ist.

unsubscribedAt ist der Zeitpunkt, zu dem sich die Person nach dem Versand von einer der Audiences des Broadcasts abgemeldet hat, über seinen Link oder auf anderem Weg. contactId ist null, wenn der Kontakt inzwischen gelöscht wurde.

emailId ist die msg_-ID der Kopie. GET /broadcasts/{id}/recipients/{emailId} liest sie mit ihrem Inhalt, und GET /emails/{id} liest sie als gesendete E-Mail.

Ablehnungen

StatusCodeWann
400invalid_cursorBei der Empfängerliste ein cursor, den diese Liste nicht ausgegeben hat.
403insufficient_scopeDer Schlüssel hat kein emails:read.
404broadcast_not_foundDie ID nennt keinen Broadcast in diesem Workspace, oder der Schlüssel ist auf bestimmte Adressen oder Domains beschränkt und der Broadcast wurde von einer gesendet, die er nicht hält.
404recipient_not_foundBei GET /broadcasts/{id}/recipients/{emailId} eine emailId, die keine Kopie dieses Broadcasts ist.