إلغاء بث
يوقف بثًا حالته `scheduled` أو `queued` أو `sending`، بما في ذلك بث وصل إلى الجميع بينما ما زالت بعض النسخ تنتظر الخروج. لا يُضاف أحد آخر، وتُلغى كل نسخة ما زالت تنتظر.
ينفّذ الاستدعاء الحقيقي على مساحة عملك، بمفتاحك أنت.
POST /broadcasts/{id}/cancel
يوقف بثًا حالته scheduled أو queued أو sending، بما في ذلك بث وصل إلى الجميع بينما ما زالت بعض النسخ تنتظر الخروج. لا يُضاف أحد آخر، وتُلغى كل نسخة ما زالت تنتظر.
مثال
يحتاج إلى emails:send. لا يوجد متن. والرد هو البث كاملًا، مختصرًا هنا.
curl -X POST "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/cancel" -H "$AUTH"{ "object": "broadcast", "id": "brd_5a8c1e3f7b2d94a06c8e1f3b", "status": "cancelled", "counts": { "recipients": 412, "created": 250, "skipped": 1, "failedToQueue": 0, "queued": 0, "sending": 0, "sent": 211, "failed": 1, "cancelled": 38 }, "cancelledAt": "2026-09-23T12:00:45.000Z"}النسخة التي يجري تسليمها تكتمل، والنسخ التي خرجت لا يمكن استرجاعها، فيحتفظ بها counts.sent ويُظهر counts.cancelled ما أُوقف. والإلغاء قبل scheduledAt لا يرسل شيئًا على الإطلاق.
بمجرد أن تخرج كل النسخ لا يبقى ما يُوقف، ويعطي الاستدعاء 409 broadcast_not_cancellable. ويمكن إلغاء البث failed الذي ما زالت له نسخ في الانتظار لإيقافها، أما الذي لا شيء له في الانتظار فيُرفض بالطريقة نفسها.
إلغاء بث مُلغى بالفعل يعيده كما هو، فإعادة المحاولة آمنة. ولا يوجد استئناف.