Listar e obter
Encontre mensagens, e veja o que aconteceu a uma delas.
Executa qualquer uma das 3 chamadas desta página contra o seu espaço de trabalho, com a sua própria chave.
Listagem
GET /emails, das mais recentes para as mais antigas. Filtre com status (separado por vírgulas) e from. A paginação é por keyset, não por offset: passe o nextCursor que lhe foi dado. A paginação por offset salta linhas em silêncio quando chegam mensagens novas enquanto percorre as páginas.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }Uma linha que tenha sido rastreada traz também um objeto tracking compacto: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Uma linha que não o tenha sido não traz chave tracking nenhuma: openCount: 0 numa mensagem que nunca levou um pixel lê-se como «ninguém a abriu», que é uma afirmação que não estamos em posição de fazer.
Obter uma
GET /emails/{id} devolve a mensagem com o estado de entrega por destinatário e o relatório de rastreio COMPLETO, em vez do resumo da lista, já que um pedido individual se pode dar ao luxo do detalhe por destinatário e das ligações. Um id que não exista dá um 404, nunca um sucesso inventado.
| Estado do destinatário | Significa |
|---|---|
| pending | Ainda não transmitida. |
| delivered | Entregue ao transporte para este endereço. |
| failed | O transporte recusou-a. |
| uncertain | Um transporte falhou a meio e não consegue dizer que destinatários alcançou. Mostrado tal como é, em vez de adivinhado num sentido ou noutro. |
Eventos
GET /emails/{id}/events devolve o rasto, dos mais antigos para os mais recentes: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled e, numa mensagem rastreada, email.opened, email.clicked e email.downloaded à medida que acontecem. Para ser avisado em vez de os andar a sondar, registe um webhook.