ब्रॉडकास्ट

import time from openemail import openemailfrom openemail.types import BroadcastCreate draft: BroadcastCreate = {    'audienceIds': ['aud_4c1b8e2a7d9f05c36b4e8a71'],    'from': 'Acme <[email protected]>',    'subject': '{{firstName|Hello}}, the September release is out',    'html': '<p>Hi {{firstName|there}},</p><p>Here is what changed this month.</p>',    'text': 'Hi {{firstName|there}}, here is what changed this month. Unsubscribe: {{unsubscribeUrl}}',    'tags': {'campaign': 'release-2026-09'},} reach = openemail.broadcasts.preview(draft)print(reach['recipients'], reach['unsubscribed'], reach['suppressed']) broadcast = openemail.broadcasts.send(draft) latest = openemail.broadcasts.get(broadcast['id'])while latest['status'] in ('scheduled', 'queued', 'sending'):    time.sleep(5)    latest = openemail.broadcasts.get(broadcast['id']) for copy in openemail.broadcasts.iterate_recipients(broadcast['id']):    print(copy['email'], copy['status'], copy['opens'], copy['clicks']) bounced = openemail.broadcasts.list_recipients(broadcast['id'], filter='bounced')if bounced['items']:    content = openemail.broadcasts.get_recipient(broadcast['id'], bounced['items'][0]['emailId'])    print(content['subject'], content['bouncedAt']) stats = openemail.broadcasts.stats(broadcast['id'], grain='day')print(stats['totals']['opened'], stats['totals']['clicked'], stats['totals']['unsubscribed']) lately = openemail.broadcasts.stats(broadcast['id'], days=1)print(lately['window']['opened'] if lately['window'] else None) month = openemail.broadcasts.analytics(days=30)for row in month['broadcasts']:    print(row['subject'], row['sent'], row['opened']) later = openemail.broadcasts.send({**draft, 'scheduledAt': 'P1D'})openemail.broadcasts.cancel(later['id']) history = openemail.broadcasts.list(audience_id=draft['audienceIds'][0])print(latest['status'], latest['counts']['sent'], len(history['items']))

broadcast एक या अधिक ऑडियंस में सभी को एक संदेश भेजता है, हर व्यक्ति के लिए अलग कॉपी के रूप में। हर कॉपी का ठीक एक प्राप्तकर्ता होता है और कोई cc या bcc नहीं, इसलिए कोई नहीं देखता कि यह और किसे गई, और हर कॉपी अपने msg_ id, events, ट्रैकिंग और webhooks वाला सामान्य ईमेल है। list_recipients उन्हें सूचीबद्ध करता है और बताता है कि हर एक का क्या हुआ। कॉपियाँ Sent फ़ोल्डर में नहीं रखी जातीं, क्योंकि broadcast ही रिकॉर्ड है।

send तुरंत लौटता है, broadcast queued स्थिति में, या scheduledAt देने पर scheduled में, और भेजना बैकग्राउंड में चलता है। send को emails:send और audiences:read चाहिए, preview को audiences:read, list, list_all, iterate, get, list_recipients, list_all_recipients, iterate_recipients, get_recipient, stats और analytics को emails:read, और cancel को emails:send।

subject, html और text हर व्यक्ति के लिए उसके संपर्क से भरे जाते हैं। {{firstName}} संपर्क के नाम का पहला शब्द है, {{lastName}} बाकी हिस्सा, {{name}} पूरा नाम, {{email}} वह पता जिस पर कॉपी जाती है और {{unsubscribeUrl}} वह लिंक जो उसकी सदस्यता छुड़ाता है।

हर फ़ील्ड बार के बाद एक फ़ॉलबैक लेता है, जो तब इस्तेमाल होता है जब संपर्क के पास उसका मान न हो, इसलिए बिना नाम सहेजे गए संपर्क के लिए {{firstName|there}} "there" बन जाता है। html में मान escape किए जाते हैं, और कोई भी दूसरा {{…}} ठीक वैसा ही छोड़ा जाता है जैसा लिखा है।

सहेजा गया टेम्पलेट भेजने के लिए html और text के बजाय template दें। वही पाँच मान उस तक props के रूप में पहुँचते हैं, पर सिर्फ़ वे props जिन्हें टेम्पलेट घोषित करता है, इसलिए जो टेम्पलेट firstName घोषित करता है उसे वह मिलता है और जो नहीं करता वह इसके कारण कभी मना नहीं होता। template.props में जो कुछ है वह हर कॉपी में एक जैसा जाता है।

हर कॉपी में एक-क्लिक सदस्यता छोड़ने के हेडर होते हैं जिनसे मेल क्लाइंट अपना सदस्यता छोड़ने का बटन दिखा पाता है, जो बड़े मेलबॉक्स प्रदाता थोक मेल से माँगते हैं। जो html या text मुख्य भाग ख़ुद {{unsubscribeUrl}} नहीं रखता उसे लिंक वाला एक पंक्ति का फ़ुटर मिलता है। टेम्पलेट ठीक वैसा ही भेजा जाता है जैसा है, इसलिए {{unsubscribeUrl}} टेम्पलेट में डालें।

सदस्यता छोड़ना व्यक्ति को हर उस ऑडियंस में सदस्यता छोड़ा हुआ चिह्नित करता है जिसमें वह broadcast गया था, और AudienceContactResource.unsubscribedAt इसे audiences.list_contacts पर दिखाता है। वह ऑडियंस और पता पुस्तिका में रहता है, उसकी दूसरी ऑडियंस नहीं छुई जातीं, और उसे एक-एक करके भेजे गए मेल अब भी जाते हैं। उसे ऑडियंस से निकालकर फिर जोड़ने से वह फिर से सदस्य बन जाता है।

broadcast audienceIds में से कम से कम एक के हर संपर्क तक पहुँचता है, एक बार, चाहे कितनी भी उसे रखती हों। यह उस संपर्क को छोड़ता है जिसने उनमें से हर उस ऑडियंस की सदस्यता छोड़ दी है जिसमें वह है, और उस पते को जो बाउंस या शिकायत के बाद, या किसी के जोड़ने से, रोक सूची में है। send के बाद पर भेजना पहुँचने से पहले किसी ऑडियंस में जोड़े गए संपर्क को भी मिलता है।

preview बिना भेजे वही संख्याएँ लौटाता है: recipients, unsubscribed और suppressed। जो send किसी तक नहीं पहुँचेगा वह 422 no_recipients raise करता है।

get कॉपियों से counts सीधे पढ़ता है, इसलिए broadcast भेजते समय इसे बार-बार जाँचें। status scheduled या queued से sending पर जाता है और सौंपी गई हर कॉपी के जाने या विफल होने पर sent पर टिकता है। जब तक कॉपियाँ इंतज़ार में हैं यह sending रहता है, भले ही completedAt बताए कि आख़िरी व्यक्ति तक पहुँच गया। failed का मतलब है पूरा broadcast रुक गया, और lastError बताता है क्यों: from पते से अब भेजा नहीं जा सकता, टेम्पलेट हल होना बंद हो गया, प्लान बीच में ख़त्म हो गया, भेजना ख़ुद बार-बार विफल होता रहा, या एक भी कॉपी लिखी नहीं जा सकी।

cancel उस broadcast को रोकता है जो scheduled, queued या sending है। कोई और नहीं जोड़ा जाता और इंतज़ार कर रही हर कॉपी रद्द होती है, जबकि जा चुकी कॉपियाँ वापस नहीं लाई जा सकतीं। जब हर कॉपी जा चुकी हो, cancel 409 broadcast_not_cancellable raise करता है, और रद्द broadcast को रद्द करना उसे जैसा है वैसा लौटा देता है।

list_recipients उन लोगों का एक पेज लौटाता है जिन तक broadcast गया, हर कॉपी की एक पंक्ति, पते के क्रम में, items, hasMore और nextCursor वाले dict के रूप में। list_all_recipients हर पेज से गुज़रकर एक list बनाता है और iterate_recipients एक बार में एक कॉपी देता है, अगला पेज तभी लाता है जब loop उसे माँगे। limit 1 से 200 तक होता है और डिफ़ॉल्ट 50 है, और cursor उन्हीं filter और q के साथ वापस भेजा जाता है।

BROADCAST_RECIPIENT_FILTERS हर filter का नाम देता है, और q पते और नाम में खोजता है, अक्षरों के छोटे-बड़े होने को अनदेखा करते हुए। Opens और clicks में image proxies और link scanners शामिल नहीं होते, और जब broadcast ट्रैकिंग बंद रखकर गया हो तो ये 0 रहते हैं।

get_recipient(id, email_id) एक कॉपी लौटाता है: वही पंक्ति, साथ में subject, html और text ठीक वैसे जैसे उस व्यक्ति को मिले, merge fields भरे हुए और उसके अपने unsubscribe लिंक के साथ। HTML open और click ट्रैकिंग जोड़े जाने से पहले का है। कोई email_id जो इस broadcast की कॉपी नहीं है 404 recipient_not_found raise करता है, और अज्ञात broadcast 404 broadcast_not_found raise करता है।

stats कुल योग और एक series लौटाता है। totals sent, delivered, bounced, complained और failed कॉपियाँ गिनता है, अभी प्रतीक्षा कर रही कॉपियों के लिए pending के साथ, और उन लोगों को जिन्होंने opened, clicked और unsubscribed किया, opens और clicks को event गिनती के रूप में। series विरल है और सबसे पुराना पहले, हर उस grain (minute, hour या day, डिफ़ॉल्ट hour) के लिए एक bucket जिसमें कुछ हुआ, UTC से पूर्व offset_minutes में काटा गया। यह हर व्यक्ति को एक बार गिनती है, उस पहले समय पर जब उसके साथ यह हुआ, इसलिए इसका जोड़ कुल योग के बराबर होता है।

get और cancel हर एक इनमें से एक लौटाता है, और send एक SentBroadcastResource लौटाता है, यानी वही फ़ील्ड और साथ में replayed, जो तब True होता है जब जवाब वह broadcast हो जिसे उसी idempotency कुंजी वाली किसी पिछली कॉल ने बनाया था। list इनका एक पेज लौटाता है, items, hasMore और nextCursor वाला dict, नए पहले, और list_all तथा iterate हर पेज से गुज़रते हैं। preview audienceIds, recipients, unsubscribed और suppressed के साथ एक BroadcastPreviewResource लौटाता है। list_recipients BroadcastRecipientResource पंक्तियों का एक पेज लौटाता है, get_recipient एक BroadcastRecipientContentResource और stats एक BroadcastStatsResource।

list_recipients, list_all_recipients और iterate_recipients की हर पंक्ति। get_recipient से मिलने वाला BroadcastRecipientContentResource इसमें subject, html और text जोड़ता है।

• broadcasts.preview()पूरा रेफ़रेंस
• broadcasts.send()पूरा रेफ़रेंस
• broadcasts.list()पूरा रेफ़रेंस
• broadcasts.list_all()पूरा रेफ़रेंस
• broadcasts.iterate()पूरा रेफ़रेंस
• broadcasts.get()पूरा रेफ़रेंस
• broadcasts.list_recipients()पूरा रेफ़रेंस
• broadcasts.list_all_recipients()पूरा रेफ़रेंस
• broadcasts.iterate_recipients()पूरा रेफ़रेंस
• broadcasts.get_recipient()पूरा रेफ़रेंस
• broadcasts.stats()पूरा रेफ़रेंस
• broadcasts.analytics()पूरा रेफ़रेंस
• broadcasts.cancel()पूरा रेफ़रेंस