پرش به مستندات
API

فهرست و دریافت

پیام‌ها را پیدا کنید، و ببینید بر سر یکی چه آمده.

GETapi.openemail.uk/emails

هر کدام از 3 فراخوانی این صفحه را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

فهرست‌کردن

GET /emails، تازه‌ترین اول. با status (جداشده با کاما) و from فیلتر کنید. صفحه‌بندی کلیدمبناست، نه offsetی: همان nextCursor را که به شما داده شده پس بفرستید. صفحه‌بندی offsetی وقتی همین‌طور که صفحه می‌زنید پیام‌های تازه می‌رسند، بی‌سروصدا از روی ردیف‌ها می‌پرد.

GET /emails?status=failed&limit=10
{ "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 ثبت کنید.