Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

Consulta de relatórios

Recursos disponíveis

URL

GET https://api.smtplw.com.br/v1/messages

Parâmetros (*)

Parâmetro Descrição Exemplo Obrigatório
status Status das mensagens enviadas. Deve conter um dos seguintes valores:
all, delivered ou errors.		 all Sim
start_date Início do período de consulta. Deve estar obrigatoriamente no formato YYYY-MM-DD e ser inferior ou igual ao término do período de consulta. 2015-01-01 Sim
end_date Término do período de consulta. Deve estar obrigatoriamente no formato YYYY-MM-DD e ser superior ou igual ao início do período de consulta. 2015-01-02 Sim
page Número da página do relatório consultado. Deve ser um número inteiro maior que 0. 1 Não
per Número de registros a serem exibidos por página. O número máximo de registros permitido por página é igual a 100. Quando não fornecido, o seu valor será de 25. 10 Não

(*) Recomendamos a utilização da ferramenta JSONLint para validar o corpo da requisição que será feita à API.

Respostas

Response code (HTTP status) Descrição
200 - Success A consulta aos relatórios foi executada com sucesso.
400 - Bad Request Parâmetros incorretos ou não encontrados. Veja a mensagem de erro para mais detalhes.
401 - Unauthorized O token da API está incorreto ou ausente. Veja a mensagem de erro para mais detalhes.
500 - Internal Server Error Erro interno inesperado na API. Tente novamente em alguns minutos e se persistir contate o suporte.

Exemplo de consulta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

GET https://api.smtplw.com.br/v1/messages?status=all&start_date=2015-01-01&end_date=2015-01-10&page=1&per=2
x-auth-token: 7sd6g8f7sdg78fsdg7fsd

RESPOSTA:
Status: 200 Sucess
Location: https://api.smtplw.com.br/v1/message_reports?status=all&start_date=2015-01-01&end_date=2015-01-10&page=1&per=2
{
  "data": {
    "messages": [
      {
        "id": 1,
        "sender": "sender@locaweb.com.br",
        "recipient": "recipient@locaweb.com.br",
        "sent_at": "2015-01-22T18:17:53.586-02:00",
        "status": "delivered",
        "bounce_code": null,
        "subject": "teste",
        "api_message_id": 10
      },
      {
        "id": 2,
        "sender": "sender@locaweb.com.br",
        "recipient": "recipient@locaweb.com.br",
        "sent_at": "2015-01-22T18:17:53.686-02:00",
        "status": "bounced",
        "bounce_code": "5.1.1",
        "subject": "test2",
        "api_message_id": 11
      }
    ]
  },
  "links": {
    "self": "http://api.smtplw.locaweb.com.br/v1/message_reports?end_date=2015-04-10&page=2&per=2&start_date=2015-01-01&status=all",
    "next": "http://api.smtplw.locaweb.com.br/v1/message_reports?end_date=2015-04-10&page=3&per=2&start_date=2015-01-01&status=all",
    "prev": null,
    "first": "http://api.smtplw.locaweb.com.br/v1/message_reports?end_date=2015-04-10&page=1&per=2&start_date=2015-01-01&status=all",
    "last": "http://api.smtplw.locaweb.com.br/v1/message_reports?end_date=2015-04-10&page=5&per=2&start_date=2015-01-01\u0026status=all"
  }
}
Atributo Descrição
id ID de envio
sender Remetente
recipient Destinatário
sent_at Data e hora do envio
status Status do envio
subject Assunto da mensagem
api_message_id ID para consulta através da URL (GET) https://api.smtplw.com.br/v1/messages/API_MESSAGE_ID