Zur Dokumentation springen
API

Die Versandspuren auflisten

Die zwei Spuren, auf denen E-Mails laufen, mit ihren Rückläufer- und Beschwerdezahlen.

GET/sending/streams

Führt jeden der 2 Aufrufe in Ihrem Workspace aus.

GET /sending/streams

Die zwei Spuren, auf denen E-Mails laufen, mit ihren Rückläufer- und Beschwerdezahlen.

Beispiel

Erfordert emails:read. E-Mails laufen auf zwei Spuren mit eigenen Warteschlangen und eigener Reputation: transactional für App-Mails wie Passwort-Resets und Belege, und broadcast für Newsletter. Jede Spur kommt mit ihren Zahlen der letzten 7 Tage und den limits, an die die Broadcast-Spur gebunden ist.

curl
curl "$OE/sending/streams" -H "$AUTH"
Antwort
{ "object": "list", "data": [{  "object": "sending_stream",  "stream": "broadcast",  "status": "active",  "pausedAt": null,  "pausedReason": null,  "resumedAt": null,  "window": {    "since": "2026-10-04T09:41:00.000Z",    "until": "2026-10-11T09:41:00.000Z",    "recipients": 18240,    "bounced": 212,    "complained": 9,    "bounceRate": 0.0116,    "complaintRate": 0.0005  },  "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}] }

Die Broadcast-Spur pausiert sich selbst, wenn ihre Rückläuferquote 4% oder ihre Beschwerdequote 0,2% über diese 7 Tage überschreitet, sobald sie minimumRecipients erreicht hat. pausedReason sagt, welche, der Workspace-Inhaber bekommt eine E-Mail, und App-Mails gehen weiter raus.

Solange sie pausiert ist, sind eine Nachricht mit stream gleich broadcast und ein neuer Broadcast ein 409 stream_paused, und laufende Broadcasts werden angehalten.

Eine Spur wählen

Erfordert emails:send. stream in POST /emails, in jeder Nachricht von POST /emails/batch und in POST /templates/{id}/send wählt die Spur. Es ist transactional, wenn Sie nichts anderes angeben, und jede Kopie eines Broadcasts läuft über broadcast.

curl
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "from": "[email protected]", "to": "[email protected]", "subject": "What is new in October", "text": "Three things shipped this month.", "stream": "broadcast" }'
Antwort
{ "object": "email", "id": "msg_5f1c9a0e7b2d4c6a8e3f1b7d", "status": "queued", "stream": "broadcast" }

Über SMTP bewirkt der Header X-OpenEmail-Stream: broadcast dasselbe, und er wird entfernt, bevor die Nachricht rausgeht.

Eine pausierte Spur fortsetzen

Erfordert domains:write und den Workspace-Inhaber. POST /sending/streams/broadcast/resume setzt die Spur fort: Angehaltene Nachrichten gehen sofort raus, und die 7-Tage-Zählung beginnt jetzt neu, bereinigen Sie also zuerst die Zielgruppe.

curl
curl -X POST "$OE/sending/streams/broadcast/resume" -H "$AUTH"
Antwort
{  "object": "sending_stream",  "stream": "broadcast",  "status": "active",  "pausedAt": null,  "pausedReason": null,  "resumedAt": null,  "window": {    "since": "2026-10-04T09:41:00.000Z",    "until": "2026-10-11T09:41:00.000Z",    "recipients": 18240,    "bounced": 212,    "complained": 9,    "bounceRate": 0.0116,    "complaintRate": 0.0005  },  "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}

Eine Spur, die nicht pausiert ist, ist ein 409 stream_not_paused.

Ein OAuth-Zugriffstoken braucht für diesen Aufruf einen Bestätigungscode. Solange die App in den letzten 60 Minuten keinen bestätigt hat, antwortet der Aufruf mit 403 step_up_required und ändert nichts. Ein API-Schlüssel wird nie gefragt. Die Seite Authentifizierung zeigt, wie Sie einen Code anfordern und bestätigen.

Referenz