Skip to main content
GET
Buscar mensagem por ID

Autorizações

x-company-key
string
header
obrigatório

Chave de autenticação do workspace (gerada na plataforma Liderhub)

Parâmetros de caminho

id
string
obrigatório

UUID da mensagem

Resposta

Mensagem retornada com sucesso

id
string<uuid>
obrigatório

UUID da mensagem (Message.id)

Exemplo:

"f8d015c2-e21b-4b96-9455-238d2e5be137"

chatId
string<uuid>
obrigatório

UUID do chat/contato ao qual a mensagem pertence

Exemplo:

"c83ccc3a-1102-4386-a533-d7a2f042b121"

outbound
boolean
obrigatório

True if message was sent by us

Exemplo:

true

createdAt
string
obrigatório

Message creation date (ISO 8601)

Exemplo:

"2026-04-18T09:21:02+00:00"

content
object

Message content (text)

Exemplo:

"Hello!"

type
object

Message type

Exemplo:

"conversation"

deliveryStatus
object

Delivery status

Exemplo:

"DELIVERED"

sentAt
string | null

Data/hora de envio (ISO 8601); null se ainda não enviada/agendada.

Exemplo:

"2026-04-18T09:21:02+00:00"

scheduledFor
object

Scheduled send time (ISO 8601)

Exemplo:

"2026-04-18T09:21:02+00:00"

mediaUrl
object

Media file URL

Exemplo:

"https://cdn.example.com/media/abc123.jpg"

mediaCaption
object

Media caption

Exemplo:

"Legenda opcional"

audioText
object

Audio transcription text

Exemplo:

"Transcrição do áudio"

errorDetails
object

Detalhes do erro quando deliveryStatus é ERRO (origem: metadata da mensagem)

Exemplo:
Última modificação em 19 de agosto de 2026