Skip to main content

Retornar entregas de uma mensagem

Este endpoint retorna um array contendo todas as tentativas de entrega realizadas para uma mensagem específica.

URL

/api/v1/messages/deliveries

Acesso

Deve ser autenticado como servidor utilizando o header X-Server-API-Key. Se não for autorizado, será retornado um erro do tipo AccessDenied.

Parâmetros

Parâmetro Tipo Valor Padrão Obrigatório

id

O ID numérico da mensagem

 Integer null Sim*

msgid

O Message-ID (RFC 822) da mensagem, com ou sem colchetes angulares

 String null Sim*

* Você deve fornecer OU id OU msgid. Se ambos forem fornecidos, id terá prioridade.

Erros

Erro Atributos

MessageNotFound

Nenhuma mensagem encontrada com o ID ou Message-ID fornecido

  • id

    O ID da mensagem buscada (quando busca por id)

  • msgid

    O Message-ID da mensagem buscada (quando busca por msgid)

Dados da Resposta

Esta ação retorna uma estrutura de entrega (Delivery Structure) contendo os atributos básicos e estendidos relacionados às tentativas de entrega da mensagem.

Delivery Structure

Atributos Básicos

Atributo Tipo Exemplo
id    
status    
details    
output    
sent_with_ssl    
log_id    
time    
timestamp    

Exemplo: Listar entregas de uma mensagem

Esse exemplo mostra como consultar as tentativas de entrega associadas a uma mensagem específica.

Por ID numérico

curl -X POST https://app.sender25.com/api/v1/messages/deliveries \
  -H "Content-Type: application/json" \
  -H "X-Server-API-Key: SUA_CHAVE_AQUI" \
  -d '{
    "id": 12345
  }'

Por Message-ID

curl -X POST https://app.sender25.com/api/v1/messages/deliveries \
  -H "Content-Type: application/json" \
  -H "X-Server-API-Key: SUA_CHAVE_AQUI" \
  -d '{
    "msgid": "uuid-da-mensagem@dominio.com"
  }'

No comments to display

Back to top