API

Получить рассылку

Одна рассылка со `counts`, прочитанными напрямую из её копий, поэтому именно этот вызов стоит опрашивать, пока она идёт.

GETapi.openemail.uk/broadcasts/{id}

Выполняет настоящий запрос в вашем рабочем пространстве, с вашим собственным ключом.

GET /broadcasts/{id}

Одна рассылка со counts, прочитанными напрямую из её копий, поэтому именно этот вызов стоит опрашивать, пока она идёт.

Пример

Требует emails:read.

curl

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

Ответ

{  "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"}

Id из другого рабочего пространства даёт 404 broadcast_not_found.

Чтобы узнать, кому ушла каждая копия и что с ней стало, выведите копии через GET /emails?broadcastId= и прочитайте одну через GET /emails/{id}.

Статусы

Статус	Значение
scheduled	Ждёт `scheduledAt`.
queued	Ждёт начала отправки.
sending	Проходит аудитории или уже прошла их, пока копии ещё ждут отправки. `completedAt` ставится, как только достигнут последний человек.
sent	Каждая переданная копия ушла или не удалась.
cancelled	Остановлена через `POST /broadcasts/{id}/cancel`.
failed	Вся рассылка остановилась: с адреса `from` больше нельзя отправлять, шаблон перестал разрешаться, тариф закончился посередине, сама отправка раз за разом не удавалась, или не удалось записать ни одной копии. `lastError` говорит, что именно.

Счётчики

Счётчик	Значение
recipients	Оценка, сделанная при создании рассылки. Потом она не меняется.
created	Записанные на данный момент копии, по одной на каждого достигнутого человека.
skipped	Люди, которых пропустили, потому что их адрес был подавлен к моменту, когда до них дошла рассылка.
failedToQueue	Люди, чью копию не удалось записать. `lastError` называет последнюю.
queued, sending, sent, failed, cancelled	Копии по состоянию, в котором каждая находится сейчас, посчитанные в реальном времени.