API

一斉配信の受信者を一覧する

一斉配信の宛先全員を、コピーごとに 1 行、アドレス順で示します。コピーの ID、ステータス、送信日時と配信日時、バウンスしたかスパム報告されたか、開封とクリックの回数、そして送信後にその人が登録解除したかどうかです。

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

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

GET /broadcasts/{id}/recipients

パラメーター

idstring必須: パス内に指定します。`POST /broadcasts` または `GET /broadcasts` から得た `brd_` ID です。
filterstring: 1 つのグループだけを残します: `pending`（まだキューにあるか送信中）、`sent`、`delivered`、`opened`、`not_opened`（送信済みで一度も開封されていない）、`clicked`、`bounced`、`complained`、`failed`（失敗またはキャンセル）、`unsubscribed`。
qstring: アドレスと名前を、大文字と小文字を区別せずに検索します。最大 200 文字です。
limitinteger: 1 ページあたりの行数で、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` が指定された場合。