API
broadcast पाएँ
एक broadcast, जिसके `counts` उसकी कॉपियों से सीधे पढ़े जाते हैं, इसलिए भेजते समय बार-बार जाँचने के लिए यही कॉल है।
GETapi.openemail.uk/broadcasts/{id}
असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।
GET /broadcasts/{id}
एक broadcast, जिसके 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"}किसी दूसरे वर्कस्पेस का id 404 broadcast_not_found है।
हर कॉपी किसे गई और उसका क्या हुआ, यह जानने के लिए कॉपियाँ GET /emails?broadcastId= से सूचीबद्ध करें और एक को GET /emails/{id} से पढ़ें।
स्थितियाँ
| स्थिति | अर्थ |
|---|---|
| scheduled | scheduledAt का इंतज़ार। |
| queued | भेजना शुरू होने का इंतज़ार। |
| sending | ऑडियंस से गुज़र रहा है, या उनसे गुज़र चुका है जबकि कॉपियाँ अब भी जाने का इंतज़ार कर रही हैं। आख़िरी व्यक्ति तक पहुँचते ही completedAt सेट होता है। |
| sent | सौंपी गई हर कॉपी जा चुकी है या विफल हो चुकी है। |
| cancelled | POST /broadcasts/{id}/cancel से रोका गया। |
| failed | पूरा broadcast रुक गया: from पते से अब भेजा नहीं जा सकता, टेम्पलेट हल होना बंद हो गया, प्लान बीच में ख़त्म हो गया, भेजना ख़ुद बार-बार विफल होता रहा, या एक भी कॉपी लिखी नहीं जा सकी। lastError बताता है कि कौन-सा। |
गिनतियाँ
| गिनती | अर्थ |
|---|---|
| recipients | broadcast बनाते समय लिया गया अनुमान। बाद में यह नहीं बदलता। |
| created | अब तक लिखी गई कॉपियाँ, हर पहुँचे व्यक्ति के लिए एक। |
| skipped | वे लोग जिन्हें छोड़ा गया क्योंकि भेजना उन तक पहुँचने तक उनका पता रोका जा चुका था। |
| failedToQueue | वे लोग जिनकी कॉपी लिखी नहीं जा सकी। lastError सबसे हाल वाले का नाम देता है। |
| queued, sending, sent, failed, cancelled | कॉपियाँ उस स्थिति के हिसाब से जिसमें हर एक अभी है, सीधे गिनी गईं। |