भेजने की लेन की सूची
वे दो लेन जिनमें मेल जाता है, उनके बाउंस और शिकायतों के आँकड़ों के साथ।
2 कॉल में से कोई भी आपके वर्कस्पेस पर चलाता है।
GET /sending/streams
वे दो लेन जिनमें मेल जाता है, उनके बाउंस और शिकायतों के आँकड़ों के साथ।
उदाहरण
emails:read चाहिए। मेल दो लेन में जाता है, जिनकी अपनी कतारें और अपनी साख होती है: पासवर्ड रीसेट और रसीदों जैसे ऐप मेल के लिए transactional, और न्यूज़लेटर के लिए broadcast। हर लेन के साथ पिछले 7 दिनों के उसके आँकड़े और वे limits आते हैं जिनमें ब्रॉडकास्ट लेन को रहना होता है।
curl "$OE/sending/streams" -H "$AUTH"{ "object": "list", "data": [{ "object": "sending_stream", "stream": "broadcast", "status": "active", "pausedAt": null, "pausedReason": null, "resumedAt": null, "window": { "since": "2026-10-04T09:41:00.000Z", "until": "2026-10-11T09:41:00.000Z", "recipients": 18240, "bounced": 212, "complained": 9, "bounceRate": 0.0116, "complaintRate": 0.0005 }, "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}] }ब्रॉडकास्ट लेन ख़ुद रुक जाती है जब उन 7 दिनों में उसकी बाउंस दर 4% या शिकायत दर 0.2% से ऊपर चली जाती है, बशर्ते वह minimumRecipients तक पहुँच चुकी हो। pausedReason बताता है कि कौन सी, वर्कस्पेस के मालिक को ईमेल मिलता है, और ऐप मेल जाता रहता है।
जब तक यह रुकी है, stream को broadcast पर रखकर भेजा गया संदेश और नया ब्रॉडकास्ट 409 stream_paused होते हैं, और जो ब्रॉडकास्ट पहले से जा रहे हैं वे रोक लिए जाते हैं।
लेन चुनें
emails:send चाहिए। POST /emails पर, POST /emails/batch के हर संदेश पर और POST /templates/{id}/send पर stream लेन चुनता है। जब तक आप कुछ और न कहें यह transactional रहता है, और ब्रॉडकास्ट की हर कॉपी broadcast पर जाती है।
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "from": "[email protected]", "to": "[email protected]", "subject": "What is new in October", "text": "Three things shipped this month.", "stream": "broadcast" }'{ "object": "email", "id": "msg_5f1c9a0e7b2d4c6a8e3f1b7d", "status": "queued", "stream": "broadcast" }SMTP पर हेडर X-OpenEmail-Stream: broadcast यही काम करता है, और संदेश जाने से पहले उसे हटा दिया जाता है।
रुकी हुई लेन फिर से शुरू करें
domains:write और वर्कस्पेस का मालिक चाहिए। POST /sending/streams/broadcast/resume लेन को फिर से शुरू करता है: रुके हुए संदेश तुरंत चले जाते हैं और 7 दिन की गिनती अब से दोबारा शुरू होती है, इसलिए पहले ऑडियंस साफ़ करें।
curl -X POST "$OE/sending/streams/broadcast/resume" -H "$AUTH"{ "object": "sending_stream", "stream": "broadcast", "status": "active", "pausedAt": null, "pausedReason": null, "resumedAt": null, "window": { "since": "2026-10-04T09:41:00.000Z", "until": "2026-10-11T09:41:00.000Z", "recipients": 18240, "bounced": 212, "complained": 9, "bounceRate": 0.0116, "complaintRate": 0.0005 }, "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}जो लेन रुकी हुई नहीं है वह 409 stream_not_paused है।
OAuth एक्सेस टोकन को इस कॉल के लिए सत्यापन कोड चाहिए। जब तक ऐप पिछले 60 मिनट में कोई कोड सत्यापित न कर ले, कॉल 403 step_up_required लौटाती है और कुछ नहीं बदलती। API कुंजी से कभी नहीं पूछा जाता। प्रमाणीकरण पेज बताता है कि कोड कैसे माँगें और सत्यापित करें।