Liệt kê và lấy thư
Tìm thư và xem điều gì đã xảy ra với một thư.
Chạy bất kỳ lệnh nào trong 3 lệnh gọi trên trang này với không gian làm việc của bạn, bằng khóa của chính bạn.
Liệt kê
GET /emails, mới nhất trước. Lọc bằng status (phân tách bằng dấu phẩy) và from. Phân trang theo keyset, không theo offset: hãy truyền nextCursor mà bạn nhận được. Phân trang theo offset sẽ âm thầm bỏ sót hàng khi có thư mới đến trong lúc bạn đang phân trang.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }Một hàng đã được theo dõi còn mang thêm đối tượng tracking rút gọn: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Một hàng không được theo dõi thì hoàn toàn không có key tracking: openCount: 0 trên một thư chưa từng chứa pixel sẽ bị hiểu là “không ai mở thư”, một khẳng định mà chúng tôi không có cơ sở để đưa ra.
Lấy một thư
GET /emails/{id} trả về thư kèm trạng thái chuyển phát theo từng người nhận, cùng báo cáo theo dõi ĐẦY ĐỦ thay vì bản tóm tắt trong danh sách, vì một lần lấy đơn lẻ đủ sức trả về chi tiết theo từng người nhận và các liên kết. Một id không tồn tại trả về 404, không bao giờ là một kết quả thành công giả tạo.
| Trạng thái người nhận | Ý nghĩa |
|---|---|
| pending | Chưa được truyền đi. |
| delivered | Đã được giao cho tầng vận chuyển đối với địa chỉ này. |
| failed | Tầng vận chuyển đã từ chối. |
| uncertain | Tầng vận chuyển thất bại giữa chừng và không thể cho biết đã tới được những người nhận nào. Được hiển thị đúng như vậy thay vì đoán theo hướng nào. |
Sự kiện
GET /emails/{id}/events trả về lịch sử sự kiện, cũ nhất trước: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled, và với thư được theo dõi thì có thêm email.opened, email.clicked và email.downloaded khi chúng xảy ra. Để được thông báo thay vì phải liên tục truy vấn, hãy đăng ký một webhook.