> ## Documentation Index > Fetch the complete documentation index at: https://docs.liderhub.ai/llms.txt > Use this file to discover all available pages before exploring further. # Buscar mensagem por ID > Retorna os dados de uma mensagem específica. ## OpenAPI ````yaml /openapi/liderhub.json get /v1/message/{id} openapi: 3.0.0 info: title: API Liderhub description: >- API REST para gerenciamento de conversas WhatsApp com IA. ## Autenticação A autenticação é obrigatória e deve ser feita utilizando o header `x-company-key`, gerado diretamente na plataforma Liderhub. Cada workspace possui uma chave própria, garantindo isolamento e segurança. ## Recursos disponíveis | Recurso | Descrição | |---------|-----------| | **Connections** | Gerenciar conexões WhatsApp do workspace | | **Contacts** | Listar, buscar, cadastrar contatos e marcar como lidos | | **Message** | Listar, buscar, enviar e cancelar mensagens agendadas | | **Agents** | Listar agentes de IA configurados | | **Users** | Listar usuários do workspace | | **Settings** | Consultar e atribuir status, origens, tags e departamentos aos chats | | **Groups** | Grupos WhatsApp: listar, detalhar, criar, atualizar nome/foto/configurações e gerenciar participantes e admins | | **Templates** | Listar, obter e enviar mensagens rápidas (templates) | ## Paginação Endpoints que retornam listas suportam paginação: - `page`: número da página (inicia em 1) - `limit`: itens por página (máximo 100) Retorno inclui metadados em `pagination`: page, limit, total, totalPages, hasNextPage, hasPreviousPage ## Filtros de lista (GET /v1/contacts) | Filtro | Tipo | Descrição | |--------|------|-----------| | `number` | string | Filtrar por número de telefone | | `connection` | UUID | Filtrar por conexão | | `id` | UUID | Filtrar por chat/contato — no máximo um resultado | | `department` | UUID | Filtrar por departamento | | `tags` | UUID | Filtrar por tag(s) - separar por vírgula | | `status` | UUID | Filtrar por status | | `stage` | enum | Filtrar por estágio: Open, Closed, Pending | | `hasUnread` | boolean | Filtrar contacts com mensagens não lidas | | `createdAfter` | ISO8601 | Criados após data | | `createdBefore` | ISO8601 | Criados antes de data | | `modifiedAfter` | ISO8601 | Modificados após data | | `modifiedBefore` | ISO8601 | Modificados antes de data | ⚠️ **Importante**: Utilize esta API de maneira responsável. Não forneça a credencial para terceiros. version: 1.0.0 contact: {} servers: - url: https://api.liderhub.com.br description: Produção security: [] tags: - name: Connections description: Gerenciar conexões WhatsApp do workspace - name: Contacts description: 'Contatos/conversas: listar e filtrar contatos.' - name: Message description: Listar, buscar, enviar e cancelar mensagens agendadas - name: Agents description: Listar agentes de IA configurados - name: Users description: Listar usuários do workspace - name: Settings description: Consultar e atribuir status, origens, tags e departamentos aos chats - name: Groups description: Gestão de grupos WhatsApp - name: Templates description: Templates / mensagens rápidas paths: /v1/message/{id}: get: tags: - Message summary: Buscar mensagem por ID description: Retorna os dados de uma mensagem específica. operationId: MessageController_findOne parameters: - name: id required: true in: path description: UUID da mensagem schema: type: string responses: '200': description: Mensagem retornada com sucesso content: application/json: schema: $ref: '#/components/schemas/MessageDetailResponseDto' example: id: f8d015c2-e21b-4b96-9455-238d2e5be137 chatId: c83ccc3a-1102-4386-a533-d7a2f042b121 content: Hello! type: conversation outbound: true deliveryStatus: DELIVERED sentAt: '2026-04-18T09:21:02+00:00' scheduledFor: '2026-04-18T09:21:02+00:00' mediaUrl: https://cdn.example.com/media/abc123.jpg mediaCaption: Legenda opcional audioText: Transcrição do áudio createdAt: '2026-04-18T09:21:02+00:00' errorDetails: code: 131060 title: Erro ao enviar mensagem message: tente novamente mais tarde '400': description: ID inválido ou rejeitado pelo banco (UUID malformado) '401': description: Não autorizado — chave de empresa inválida ou ausente '404': description: Mensagem não encontrada neste workspace '500': description: >- Erro interno ao consultar o banco (ex.: indisponibilidade do serviço de dados) security: - x-company-key: [] components: schemas: MessageDetailResponseDto: type: object properties: id: type: string description: UUID da mensagem (`Message.id`) format: uuid example: f8d015c2-e21b-4b96-9455-238d2e5be137 chatId: type: string description: UUID do chat/contato ao qual a mensagem pertence format: uuid example: c83ccc3a-1102-4386-a533-d7a2f042b121 content: type: object description: Message content (text) example: Hello! type: type: object description: Message type example: conversation outbound: type: boolean description: True if message was sent by us example: true deliveryStatus: type: object description: Delivery status example: DELIVERED sentAt: type: string description: Data/hora de envio (ISO 8601); `null` se ainda não enviada/agendada. nullable: true example: '2026-04-18T09:21:02+00:00' scheduledFor: type: object description: Scheduled send time (ISO 8601) example: '2026-04-18T09:21:02+00:00' mediaUrl: type: object description: Media file URL example: https://cdn.example.com/media/abc123.jpg mediaCaption: type: object description: Media caption example: Legenda opcional audioText: type: object description: Audio transcription text example: Transcrição do áudio createdAt: type: string description: Message creation date (ISO 8601) example: '2026-04-18T09:21:02+00:00' errorDetails: type: object description: >- Detalhes do erro quando `deliveryStatus` é `ERRO` (origem: metadata da mensagem) example: code: 131060 title: Erro ao enviar mensagem message: tente novamente mais tarde required: - id - chatId - outbound - createdAt securitySchemes: x-company-key: type: apiKey in: header name: x-company-key description: Chave de autenticação do workspace (gerada na plataforma Liderhub) ````