API
一斉配信を取得する
コピーから直接読んだ `counts` 付きの一斉配信 1 件です。送信中にポーリングするのはこの呼び出しです。
GETapi.openemail.uk/broadcasts/{id}
実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。
GET /broadcasts/{id}
コピーから直接読んだ counts 付きの一斉配信 1 件です。送信中にポーリングするのはこの呼び出しです。
例
emails:read が必要です。
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} で 1 通を読みます。
状態
| ステータス | 意味 |
|---|---|
| scheduled | scheduledAt を待っています。 |
| queued | 送信の開始を待っています。 |
| sending | オーディエンスを進んでいるか、進み終えたがまだ送信待ちのコピーがあります。最後の人に届いた時点で completedAt が設定されます。 |
| sent | 渡したすべてのコピーが送られたか失敗しました。 |
| cancelled | POST /broadcasts/{id}/cancel で止められました。 |
| failed | 一斉配信全体が止まりました。from アドレスから送信できなくなった、テンプレートが解決できなくなった、途中でプランが尽きた、送信自体が失敗し続けた、またはコピーを 1 通も書き込めなかった、のいずれかで、lastError がどれかを示します。 |
カウント
| カウント | 意味 |
|---|---|
| recipients | 一斉配信の作成時に取った見積もり。その後は変わりません。 |
| created | これまでに書き込まれたコピー。届いた一人につき 1 通です。 |
| skipped | 送信が届いた時点でアドレスが抑止されていたために飛ばされた人。 |
| failedToQueue | コピーを書き込めなかった人。lastError が最新のものを示します。 |
| queued, sending, sent, failed, cancelled | 各コピーの現在の状態ごとの数を、その場で数えたもの。 |