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 | نسخهها بر اساس وضعیتی که هر کدام الان دارد، زنده شمرده میشوند. |