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 da mensagem	Integer	null	Sim

Erros

Erro	Atributos
MessageNotFound Nenhuma mensagem encontrada com o ID fornecido	id O ID da mensagem buscada

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