v1

latestOpenAPI 3.0.02026-07-26253547.8 KB

Message

Buscar mensagem por ID

Retorna os dados de uma mensagem específica.

get/v1/message/{id}

Path parameters

idstring required

UUID da mensagem

Response

Mensagem retornada com sucesso

idstring uuid required

UUID da mensagem (Message.id)

chatIdstring uuid required

UUID do chat/contato ao qual a mensagem pertence (Chat.id)

contentobject

Message content (text)

typeobject

Message type

outboundboolean required

True if message was sent by us

deliveryStatusobject

Delivery status

sentAtstring nullable

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

scheduledForobject

Scheduled send time (ISO 8601)

mediaUrlobject

Media file URL

mediaCaptionobject

Media caption

audioTextobject

Audio transcription text

createdAtstring required

Message creation date (ISO 8601)

errorDetailsobject

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

Example response

{
  "id": "f8d015c2-e21b-4b96-9455-238d2e5be137",
  "chatId": "c83ccc3a-1102-4386-a533-d7a2f042b121",
  "outbound": true,
  "sentAt": "2026-04-18T09:21:02+00:00",
  "createdAt": "2026-04-18T09:21:02+00:00",
  "errorDetails": {
    "code": 131060,
    "title": "Erro ao enviar mensagem",
    "message": "tente novamente mais tarde"
  }
}