API
جلب بث
بث واحد مع `counts` تُقرأ مباشرة من نسخه، ما يجعل هذا الاستدعاء هو الذي تستطلعه أثناء الإرسال.
GETapi.openemail.uk/broadcasts/{id}
ينفّذ الاستدعاء الحقيقي على مساحة عملك، بمفتاحك أنت.
GET /broadcasts/{id}
بث واحد مع counts تُقرأ مباشرة من نسخه، ما يجعل هذا الاستدعاء هو الذي تستطلعه أثناء الإرسال.
مثال
يحتاج إلى 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"}المعرّف من مساحة عمل أخرى يعطي 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 | النسخ حسب الحالة التي فيها كل منها الآن، محسوبة مباشرة. |