API

किसी broadcast के प्राप्तकर्ताओं की सूची

broadcast जिन सभी तक गया, हर कॉपी की एक पंक्ति, पते के क्रम में: कॉपी का id, उसका स्टेटस, वह कब भेजी गई और कब डिलीवर हुई, क्या वह बाउंस हुई या स्पैम के रूप में रिपोर्ट की गई, वह कितनी बार खोली और क्लिक की गई, और क्या व्यक्ति ने उसके जाने के बाद unsubscribe किया।

GETapi.openemail.uk/broadcasts/{id}/recipients

असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

GET /broadcasts/{id}/recipients

पैरामीटर

idstringआवश्यक: पाथ में। `POST /broadcasts` या `GET /broadcasts` से मिला एक `brd_` id।
filterstring: एक समूह रखता है: `pending` (अभी कतार में या भेजी जा रही), `sent`, `delivered`, `opened`, `not_opened` (भेजी गई और कभी नहीं खोली गई), `clicked`, `bounced`, `complained`, `failed` (विफल या रद्द) या `unsubscribed`।
qstring: पते और नाम में खोजता है, अक्षरों के छोटे-बड़े होने को अनदेखा करते हुए। अधिकतम 200 अक्षर।
limitinteger: प्रति पेज पंक्तियाँ, 1 से 200। डिफ़ॉल्ट 50।
cursorstring: पिछले पेज का `nextCursor`, जैसा आया वैसा ही लौटाया गया, उन्हीं `filter` और `q` के साथ। यह याद रखता है कि आख़िरी पंक्ति कहाँ थी, इसलिए पेजों के बीच बदलने वाली कोई पंक्ति कभी पूरी सूची से गुज़रने को नहीं तोड़ती।

उदाहरण

emails:read चाहिए। जवाब broadcast_recipient पंक्तियों का एक पेज है।

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/recipients?filter=opened&limit=50" -H "$AUTH"

प्रतिक्रिया

{  "object": "list",  "data": [    {      "object": "broadcast_recipient",      "emailId": "msg_01dad25067bc4dac966d515d",      "contactId": "6f1c2a8e-3b4d-4e9f-a1c7-2d5e8b0f9a34",      "email": "[email protected]",      "name": "Ada Lovelace",      "status": "sent",      "sentAt": "2026-09-23T12:00:09.000Z",      "deliveredAt": "2026-09-23T12:00:11.000Z",      "bouncedAt": null,      "complainedAt": null,      "failure": null,      "opens": 3,      "firstOpenAt": "2026-09-23T12:14:30.000Z",      "clicks": 1,      "firstClickAt": "2026-09-23T12:15:02.000Z",      "unsubscribedAt": null    }  ],  "hasMore": true,  "nextCursor": "WyJhZGFAZXhhbXBsZS5jb20iLCJtc2dfMDFkYWQyNTA2N2JjNGRhYzk2NmQ1MTVkIl0"}

Opens और clicks में image proxies और link scanners शामिल नहीं होते, और जब broadcast ट्रैकिंग बंद रखकर भेजा गया हो तो ये 0 रहते हैं।

status send log पर कॉपी की स्थिति है: queued, scheduled, sending, sent, failed या cancelled। deliveredAt, bouncedAt और complainedAt उसके लिए पहले email.delivered, email.bounced और email.complained हैं, और failure बताता है कि कोई कॉपी क्यों विफल हुई।

unsubscribedAt वह समय है जब व्यक्ति ने broadcast जाने के बाद उसकी किसी ऑडियंस से unsubscribe किया, उसके लिंक से या किसी और तरह। contactId null होता है जब संपर्क बाद में हटा दिया गया हो।

emailId कॉपी का msg_ id है। GET /broadcasts/{id}/recipients/{emailId} उसे उसकी सामग्री के साथ पढ़ता है, और GET /emails/{id} उसे भेजे गए ईमेल के रूप में पढ़ता है।

अस्वीकृतियाँ

स्थिति	कोड	कब
400	`invalid_cursor`	प्राप्तकर्ताओं की सूची पर, कोई `cursor` जो उस सूची ने नहीं दिया।
403	`insufficient_scope`	कुंजी के पास `emails:read` नहीं है।
404	`broadcast_not_found`	id इस वर्कस्पेस के किसी broadcast का नाम नहीं देता, या कुंजी कुछ ख़ास पतों या डोमेन तक सीमित है और broadcast ऐसी जगह से भेजा गया जो उसके पास नहीं है।
404	`recipient_not_found`	`GET /broadcasts/{id}/recipients/{emailId}` पर, कोई `emailId` जो इस broadcast की कॉपी नहीं है।