Список и получение
Найти сообщения и посмотреть, что стало с одним из них.
Выполняет любой из 3 запросов на этой странице в вашем рабочем пространстве, с вашим собственным ключом.
Список
GET /emails, от новых к старым. Фильтруйте по status (через запятую) и from. Постраничный вывод keyset, а не 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} возвращает сообщение с состоянием доставки по каждому получателю и ПОЛНЫЙ отчёт трекинга, а не сводку из списка, потому что одно получение может позволить себе разбивку по получателям и ссылки. Несуществующий 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.