فهرست و دریافت
پیامها را پیدا کنید، و ببینید بر سر یکی چه آمده.
هر کدام از 3 فراخوانی این صفحه را با کلید خودتان روی فضای کاری شما اجرا میکند.
فهرستکردن
GET /emails، تازهترین اول. با status (جداشده با کاما) و from فیلتر کنید. صفحهبندی کلیدمبناست، نه offsetی: همان nextCursor را که به شما داده شده پس بفرستید. صفحهبندی offsetی وقتی همینطور که صفحه میزنید پیامهای تازه میرسند، بیسروصدا از روی ردیفها میپرد.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }ردیفی که ردیابی شده، یک شیء فشردهٔ tracking هم با خود دارد: opens، clicks، opened، clicked، openCount، clickCount، firstOpenAt. ردیفی که ردیابی نشده اصلاً کلید tracking ندارد: openCount: 0 روی پیامی که هرگز پیکسلی نداشته یعنی «کسی بازش نکرد»، و این ادعایی است که ما در جایگاه گفتنش نیستیم.
دریافت یکی
GET /emails/{id} پیام را با وضعیت تحویل بهازای هر گیرنده برمیگرداند، و گزارش کاملِ ردیابی را بهجای خلاصهٔ فهرست، چون یک دریافت از پسِ تفکیک بهازای هر گیرنده و پیوندها برمیآید. شناسهای که وجود ندارد 404 میگیرد، نه موفقیتی ساختگی.
| وضعیت گیرنده | معنا |
|---|---|
| pending | هنوز منتقل نشده. |
| delivered | برای این نشانی به لایهٔ انتقال سپرده شده. |
| failed | لایهٔ انتقال آن را رد کرد. |
| uncertain | یک لایهٔ انتقال نیمهراه شکست خورد و نمیتواند بگوید به کدام گیرندهها رسیده. بهجای حدسزدن یکی از دو سو، همانطور که هست نشان داده میشود. |
رویدادها
GET /emails/{id}/events رد پیام را برمیگرداند، قدیمیترین اول: email.accepted، email.queued، email.scheduled، email.sent، email.failed، email.cancelled، email.rescheduled، و روی یک پیام ردیابیشده، email.opened، email.clicked و email.downloaded همینطور که رخ میدهند. برای اینکه به شما گفته شود بهجای آنکه نظرسنجی کنید، یک webhook ثبت کنید.