सूची और प्राप्ति
संदेश ढूँढ़ें, और देखें कि किसी एक का क्या हुआ।
इस पेज की 3 कॉल में से कोई भी आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।
सूचीकरण
GET /emails, नए से पुराने। status (अल्पविराम से अलग) और from से फ़िल्टर करें। पेजिनेशन keyset है, offset नहीं: जो nextCursor आपको मिला उसे भेजें। जब आप पेज कर रहे हों और नए संदेश आ जाएँ, तो offset पेजिंग चुपचाप पंक्तियाँ छोड़ देती है।
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }जिस पंक्ति को track किया गया था वह एक संक्षिप्त tracking ऑब्जेक्ट भी रखती है: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt। जिसे track नहीं किया गया उसमें tracking कुंजी होती ही नहीं: जिस संदेश में कभी पिक्सेल था ही नहीं उस पर openCount: 0 का मतलब निकलता है "किसी ने इसे नहीं खोला", और ऐसा दावा करने की स्थिति में हम हैं ही नहीं।
एक को प्राप्त करना
GET /emails/{id} संदेश को प्रति-प्राप्तकर्ता डिलीवरी स्थिति के साथ लौटाता है, और सूची सारांश के बजाय पूरी tracking रिपोर्ट के साथ, क्योंकि एक retrieve प्रति-प्राप्तकर्ता विश्लेषण और लिंक वहन कर सकता है। जो id मौजूद नहीं है उस पर 404 मिलता है, कभी गढ़ी हुई सफलता नहीं।
| प्राप्तकर्ता की स्थिति | अर्थ |
|---|---|
| pending | अभी प्रेषित नहीं हुआ। |
| delivered | इस पते के लिए ट्रांसपोर्ट को सौंप दिया गया। |
| failed | ट्रांसपोर्ट ने इसे अस्वीकार कर दिया। |
| uncertain | ट्रांसपोर्ट बीच में विफल हो गया और यह नहीं बता सकता कि वह किन प्राप्तकर्ताओं तक पहुँचा। किसी भी तरफ़ अनुमान लगाने के बजाय इसे वैसा ही दिखाया जाता है। |
इवेंट
GET /emails/{id}/events पूरा सिलसिला लौटाता है, पुराने से नए: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled, और track किए गए संदेश पर email.opened, email.clicked तथा email.downloaded, जैसे-जैसे वे होते हैं। इनके लिए पोल करने के बजाय बताए जाने के लिए, एक webhook पंजीकृत करें।