Skip to main content

Retornar detalhes da mensagem

Este endpoint retorna todos os detalhes disponíveis sobre uma mensagem específica.

URL

/api/v1/messages/message

Acesso

Deve ser autenticado como servidor utilizando o header X-Server-API-Key. Caso não seja 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 mensagem, contendo os dados básicos. Por padrão, não são retornadas expansões. Para obter dados adicionais, envie o parâmetro _expansions com os nomes das expansões desejadas ou true para todas.

Message Structure

Atributos Básicos

Atributo Tipo Exemplo
id    
token    

Expansões Disponíveis

Expansões são estruturas aninhadas de outros objetos relacionados à mensagem. Por padrão, nenhuma expansão é retornada, mas você pode usar o parâmetro _expansions para incluí-las.

Expansão Tipo Descrição
status    
details    
inspection    
plain_body    
html_body    
attachments    
headers    
raw_message    

Exemplo: Buscar detalhes de uma mensagem com expansões

Este exemplo mostra como solicitar dados adicionais da mensagem utilizando o parâmetro _expansions. Você pode passar uma lista com os campos desejados ou true para expandir tudo.

Por ID numérico

curl -X POST https://app.sender25.com/api/v1/messages/message \
  -H "Content-Type: application/json" \
  -H "X-Server-API-Key: SUA_CHAVE_AQUI" \
  -d '{
    "id": 12345,
    "_expansions": ["status", "plain_body", "html_body", "attachments", "headers"]
  }'

Por Message-ID

curl -X POST https://app.sender25.com/api/v1/messages/message \
  -H "Content-Type: application/json" \
  -H "X-Server-API-Key: SUA_CHAVE_AQUI" \
  -d '{
    "msgid": "uuid-da-mensagem@dominio.com",
    "_expansions": ["status", "plain_body", "html_body"]
  }'

Se quiser retornar todas as expansões disponíveis, utilize "_expansions": true:

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

No comments to display

Back to top