문서로 건너뛰기
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}로 하나를 읽으세요.

상태

상태의미
scheduledscheduledAt을 기다리는 중.
queued발송이 시작되기를 기다리는 중.
sending오디언스를 훑는 중이거나, 다 훑었지만 아직 나갈 사본이 기다리는 중. 마지막 사람에게 닿는 즉시 completedAt이 설정됩니다.
sent넘긴 모든 사본이 나갔거나 실패했습니다.
cancelledPOST /broadcasts/{id}/cancel로 멈췄습니다.
failed브로드캐스트 전체가 멈췄습니다. from 주소로 더 이상 보낼 수 없거나, 템플릿을 해석할 수 없게 되었거나, 요금제가 중간에 소진되었거나, 발송 자체가 계속 실패했거나, 사본을 한 통도 기록하지 못한 경우이며, lastError가 어느 쪽인지 알려 줍니다.

카운트

카운트의미
recipients브로드캐스트를 만들 때 잡은 추정치. 이후에는 바뀌지 않습니다.
created지금까지 기록된 사본. 닿은 사람마다 한 통입니다.
skipped발송이 닿았을 때 주소가 차단되어 있어 건너뛴 사람.
failedToQueue사본을 기록하지 못한 사람. lastError가 가장 최근 것을 알려 줍니다.
queued, sending, sent, failed, cancelled각 사본이 지금 있는 상태별로 실시간으로 센 사본 수.