API

브로드캐스트의 받는 사람 나열

브로드캐스트를 받은 모든 사람을 사본마다 한 행씩, 주소순으로 보여 줍니다. 사본 ID, 상태, 발송 및 전달 시각, 반송되었거나 스팸으로 신고되었는지, 열람 및 클릭 횟수, 그리고 발송 후 그 사람이 수신 거부했는지입니다.

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

본인 키로 워크스페이스에 실제 호출을 실행합니다.

GET /broadcasts/{id}/recipients

매개변수

idstring필수: 경로에 넣습니다. `POST /broadcasts` 또는 `GET /broadcasts`에서 받은 `brd_` ID입니다.
filterstring: 한 그룹만 남깁니다: `pending`(아직 대기열에 있거나 발송 중), `sent`, `delivered`, `opened`, `not_opened`(발송되었지만 한 번도 열리지 않음), `clicked`, `bounced`, `complained`, `failed`(실패 또는 취소) 또는 `unsubscribed`.
qstring: 주소와 이름을 대소문자 구분 없이 검색합니다. 최대 200자입니다.
limitinteger: 페이지당 행 수로, 1에서 200까지입니다. 기본값은 50입니다.
cursorstring: 이전 페이지의 `nextCursor`를 받은 그대로, 같은 `filter` 및 `q`와 함께 돌려보냅니다. 마지막 행의 위치를 담고 있으므로, 페이지 사이에 행이 바뀌어도 순회가 깨지지 않습니다.

예시

emails:read가 필요합니다. 응답은 broadcast_recipient 행의 페이지입니다.

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/recipients?filter=opened&limit=50" -H "$AUTH"

응답

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

열람과 클릭에는 이미지 프록시와 링크 스캐너가 만든 것이 빠지며, 추적을 끄고 보낸 브로드캐스트에서는 0으로 유지됩니다.

status는 발송 로그상의 사본 상태로 queued, scheduled, sending, sent, failed, cancelled 중 하나입니다. deliveredAt, bouncedAt, complainedAt은 해당 사본에 대한 첫 email.delivered, email.bounced, email.complained이며, failure는 사본이 실패한 이유를 알려 줍니다.

unsubscribedAt은 발송 후 그 사람이 브로드캐스트의 오디언스 중 하나에서 링크를 통하거나 다른 방법으로 수신 거부한 시각입니다. 그 뒤 연락처가 삭제되었으면 contactId는 null입니다.

emailId는 사본의 msg_ ID입니다. GET /broadcasts/{id}/recipients/{emailId}는 내용과 함께 읽고, GET /emails/{id}는 보낸 이메일로 읽습니다.

거절

상태	코드	발생 조건
400	`invalid_cursor`	받는 사람 목록에서, 그 목록이 내준 적 없는 `cursor`.
403	`insufficient_scope`	키에 `emails:read`가 없습니다.
404	`broadcast_not_found`	id가 이 워크스페이스의 어떤 브로드캐스트도 가리키지 않거나, 키가 특정 주소나 도메인으로 제한되어 있고 브로드캐스트가 키가 가지지 않은 곳에서 보내졌습니다.
404	`recipient_not_found`	`GET /broadcasts/{id}/recipients/{emailId}`에서, 이 브로드캐스트의 사본이 아닌 `emailId`.