Sign in
v1Messages

Retrieve a message

Returns a single message by its id. Use GET /v1/conversations/{id}/messages to list the messages of a conversation.

get/v1/messages/{id}

Path parameters

idstring required

Response

idstring required

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

conversationIdnumber required

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

callIdnumber nullable

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

channelIdnumber nullable

Id do canal pelo qual a mensagem passou

sender'contact' | 'operator' | 'bot' | 'note' | 'system' required
typenumber required

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

operatorIdnumber nullable
operatorNamestring nullable
contactNamestring nullable
contentstring required

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

textstring required

Texto extraído de content

isMediaboolean required
fileNamestring nullable
externalIdstring nullable

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

replyToobject nullable

Referência da mensagem respondida, quando houver

statusnumber nullable

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

isSentboolean required
isErrorboolean required
errorDescriptionstring nullable
isDeletedboolean required
isScheduledboolean required
isForwardingboolean required
viewedAtstring nullable

Quando a mensagem foi visualizada pelo destinatário

createdAtstring required

Example response

{
  "id": "37826587",
  "conversationId": 1234567,
  "callId": 987654,
  "channelId": 103,
  "sender": "contact",
  "operatorId": 42,
  "operatorName": "Maria",
  "contactName": "Fulano",
  "content": "[{\"insert\":\"Olá\"}]",
  "text": "Olá",
  "media": [
    {
      "kind": "image",
      "url": "https://cdn.kinbox.com.br/media/abc.jpg"
    }
  ],
  "fileName": "contrato.pdf",
  "externalId": "wamid.HBgLNTU4NT...",
  "status": 6,
  "isSent": true,
  "viewedAt": "2026-09-14T12:00:00.000Z",
  "createdAt": "2026-09-14T11:58:00.000Z"
}

Changes

Changed in 1 of the 18 revisions of this API.1