Skip to main content
GET
Retrieve a message

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Id da mensagem. Numérico para mensagens comuns; pode ser um ObjectId para mensagens sem id numérico.

Example:

"37826587"

conversationId
number
required

Id da conversa (contato no canal) a que a mensagem pertence

Example:

1234567

sender
enum<string>
required
Available options:
contact,
operator,
bot,
note,
system
Example:

"contact"

type
number
required

Tipo bruto: 0 comum, 1 sistema, 2 nota interna, 3 bot, 4 e-mail

Example:

0

content
string
required

Conteúdo bruto como armazenado (normalmente um Quill Delta serializado)

Example:

"[{\"insert\":\"Olá\"}]"

text
string
required

Texto extraído de content

Example:

"Olá"

isMedia
boolean
required
Example:

false

isSent
boolean
required
Example:

true

isError
boolean
required
Example:

false

isDeleted
boolean
required
Example:

false

isScheduled
boolean
required
Example:

false

isForwarding
boolean
required
Example:

false

createdAt
string
required
Example:

"2026-09-14T11:58:00.000Z"

callId
number | null

Id da sessão de atendimento (call) da mensagem

Example:

987654

channelId
number | null

Id do canal pelo qual a mensagem passou

Example:

103

operatorId
number | null
Example:

42

operatorName
string | null
Example:

"Maria"

contactName
string | null
Example:

"Fulano"

media
object[]

Mídias extraídas de content

fileName
string | null
Example:

"contrato.pdf"

externalId
string | null

Id da mensagem na plataforma de origem (ex.: WhatsApp)

Example:

"wamid.HBgLNTU4NT..."

replyTo
object | null

Referência da mensagem respondida, quando houver

status
number | null

Status de envio: 0 enviada ao módulo, 2 enviada à API, 4 aguardando reenvio, 6 entregue, 8 erro

Example:

6

errorDescription
string | null
viewedAt
string | null

Quando a mensagem foi visualizada pelo destinatário

Example:

"2026-09-14T12:00:00.000Z"