Pular para o conteúdo principal
GET
/
v1
/
message
/
{id}
Buscar mensagem por ID
curl --request GET \
  --url https://api.liderhub.com.br/v1/message/{id} \
  --header 'x-company-key: <api-key>'
{
  "messageId": "f8d015c2-e21b-4b96-9455-238d2e5be137",
  "contactId": "c83ccc3a-1102-4386-a533-d7a2f042b121",
  "outbound": true,
  "createdAt": "<string>",
  "content": "Hello!",
  "type": "conversation",
  "deliveryStatus": "DELIVERED",
  "sentAt": {},
  "scheduledFor": {},
  "mediaUrl": {},
  "mediaCaption": {},
  "audioText": {},
  "errorDetails": {
    "code": 131060,
    "title": "Erro ao enviar mensagem",
    "message": "tente novamente mais tarde"
  }
}

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

​
messageId
string
obrigatório

Message unique identifier

Exemplo:

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

​
contactId
string
obrigatório

Contact/Chat ID

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 string)

​
content
object

Message content (text)

Exemplo:

"Hello!"

​
type
object

Message type

Exemplo:

"conversation"

​
deliveryStatus
object

Delivery status

Exemplo:

"DELIVERED"

​
sentAt
object

When message was sent (ISO string)

​
scheduledFor
object

Scheduled send time (ISO string)

​
mediaUrl
object

Media file URL

​
mediaCaption
object

Media caption

​
audioText
object

Audio transcription text

​
errorDetails
object

Error details when deliveryStatus is ERRO

Exemplo:
{
  "code": 131060,
  "title": "Erro ao enviar mensagem",
  "message": "tente novamente mais tarde"
}
Last modified on March 24, 2026