> ## Documentation Index > Fetch the complete documentation index at: https://docs.wppfy.com/llms.txt > Use this file to discover all available pages before exploring further. # Buscar mensagens em um chat > Busca mensagens com múltiplos filtros disponíveis. Este endpoint permite: 1. **Busca por ID específico**: Use `id` para encontrar uma mensagem exata 2. **Filtrar por chat**: Use `chatid` para mensagens de uma conversa específica 3. **Filtrar por rastreamento**: Use `track_source` e `track_id` para mensagens com dados de tracking 4. **Histórico de ligações**: Use apenas `messageType: call`, `limit` e `offset` para listar as chamadas mais recentes. A resposta pode trazer `callPeer` (identidade conhecida do contato) e `content.isVideo`. 5. **Status dos contatos**: Use `chatid: status@broadcast` para os Status recebidos, mesmo sem webhook `status_posts`. Sem esse `chatid`, a busca não traz Status. Eles ficam guardados por 24 horas, como no WhatsApp (a limpeza roda uma vez por dia, então filtre `messageTimestamp` se precisar do corte exato), e o Status que o autor apaga sai da lista. Cada um vem com o autor em `sender_pn`, `sender_lid` e `sender_image_preview_url` (foto, quando conhecida) e, nos de imagem, vídeo ou link, com a miniatura em `content.JPEGThumbnail`. Baixe a mídia pelo `/message/download`. Um Status que não abriu vem com `messageType: error` e só o ID, o autor e o horário. **Status de grupo** (enviados e recebidos) ficam na conversa de cada grupo com `messageType: GroupStatusMessage` e o texto em `text`: liste todos com `messageType: GroupStatusMessage`, sem `chatid`. Saem em 24 horas, como os outros Status. 6. **Limitar resultados**: Use `limit` para controlar quantas mensagens retornar 7. **Ordenação**: Resultados ordenados por data (mais recentes primeiro) Fora dos Status, as mensagens guardadas só trazem no `content` as miniaturas em base64 que não têm cópia no servidor (prévia de link sem cópia, localização, anúncio, convites); as de mídia que pode ser baixada de novo (`JPEGThumbnail` e afins) chegam só no webhook, na hora da mensagem. Nas mensagens enviadas pela API nos últimos 7 dias, `sendPayload` traz o pedido de envio, sem os arquivos em base64 (links vêm). Depois do envio (em conversa individual, 1 hora depois), o arquivo em base64 guardado vira o texto `[arquivo removido após o envio: tipo, N bytes]`. ## OpenAPI ````yaml /openapi-pt-BR.json post /message/find openapi: 3.1.0 info: title: WppFy - WhatsApp API version: 1.0.0 description: > API para gerenciamento de instâncias do WhatsApp e comunicações. ## Recomendação Importante: WhatsApp Business **É ALTAMENTE RECOMENDADO usar contas do WhatsApp Business** em vez do WhatsApp normal para integração, o WhatsApp normal pode apresentar inconsistências, desconexões, limitações e instabilidades durante o uso com a nossa API. ## Autenticação - Endpoints regulares requerem um header 'token' com o token da instância ## Estados da Instância As instâncias podem estar nos seguintes estados: - `disconnected`: Desconectado do WhatsApp - `connecting`: Em processo de conexão - `connected`: Conectado e autenticado com sucesso servers: - url: https://api.wppfy.com security: - token: [] tags: - name: Instancia description: | Operações relacionadas ao ciclo de vida de uma instância, como conectar, desconectar e verificar o status. - name: Proxy description: > A WppFy opera com um proxy interno como padrão. Você pode manter esse padrão, configurar um proxy próprio via `proxy_url` ou usar seu celular android como proxy instalando o app em https://github.com/WppFy/silver_proxy_apk (APK direto: https://github.com/WppFy/silver_proxy_apk/raw/refs/heads/main/silver_proxy.apk). Se nada for enviado, seguimos no proxy interno. IPs são brasileiros; para clientes internacionais, considere um proxy da região do cliente. - name: Perfil description: | Operações relacionadas ao perfil da instância do WhatsApp, como alterar nome e imagem de perfil. - name: Business description: | ⚠️ **EXPERIMENTAL** - Endpoints ainda não testados completamente. Operações relacionadas ao perfil comercial do WhatsApp Business. Permite consultar e atualizar dados do perfil comercial como descrição, endereço, email, categorias e gerenciar o catálogo de produtos. **Requisitos:** - A conta atualmente conectada deve ser uma conta **WhatsApp Business** - Contas pessoais do WhatsApp não possuem perfil comercial **Nota:** Estes endpoints podem não funcionar como esperado. Reporte problemas encontrados. - name: Chamadas description: | Operações relacionadas a chamadas peloWhatsApp. Permite realizar e rejeitar chamadas programaticamente. - name: Enviar Mensagem description: > Endpoints para envio de mensagens do WhatsApp com diferentes tipos de conteúdo. ## Campos Opcionais Comuns Todos os endpoints de envio de mensagem suportam os seguintes campos opcionais: - **`delay`** *(integer)*: Atraso em milissegundos antes do envio - Durante o atraso aparecerá "Digitando..." ou "Gravando áudio..." dependendo do tipo - Exemplo: `5000` (5 segundos) - **`readchat`** *(boolean)*: Marcar chat como lido após envio - Remove o contador de mensagens não lidas do chat - Exemplo: `true` - **`readmessages`** *(boolean)*: Marcar últimas mensagens recebidas como lidas - Marca as últimas 10 mensagens **recebidas** (não enviadas por você) como lidas - Útil para confirmar leitura de mensagens pendentes antes de responder - Diferente do `readchat` que apenas remove contador de não lidas - Exemplo: `true` - **`replyid`** *(string)*: ID da mensagem para responder - Cria uma resposta vinculada à mensagem original - Suporte varia por tipo de mensagem - Exemplo: `"3A12345678901234567890123456789012"` - **`mentions`** *(string)*: Números para mencionar (apenas para envio em grupos) - Números específicos: `"5511999999999,5511888888888"` - Mencionar todos: `"all"` - **`forward`** *(boolean)*: Marca a mensagem como encaminhada no WhatsApp - Adiciona o indicador "Encaminhada" na mensagem - Exemplo: `true` - **`track_source`** *(string)*: Origem do rastreamento da mensagem - Identifica o sistema ou fonte que está enviando a mensagem - Útil para integrações (ex: "chatwoot", "crm", "chatbot") - Exemplo: `"chatwoot"` - **`track_id`** *(string)*: ID para rastreamento da mensagem - Identificador livre para acompanhar a mensagem em sistemas externos - Permite correlacionar mensagens entre diferentes plataformas - **Nota**: O sistema aceita valores duplicados - não há validação de unicidade - Use o mesmo ID em várias mensagens se fizer sentido para sua integração - Exemplo: `"msg_123456789"` ### Envio para Grupos - **`number`** *(string)*: Para enviar mensagem para grupo, use o ID do grupo que termina com `@g.us` - Exemplo: `"120363012345678901@g.us"` - **Como obter o ID do grupo:** - Use o `chatid` do webhook recebido quando alguém envia mensagem no grupo - Use o endpoint `GET /group/list` para listar todos os grupos e seus IDs ## Placeholders Disponíveis Todos os endpoints de envio de mensagem suportam placeholders dinâmicos para personalização automática: ### Campos de Nome - **`{{name}}`**: Nome consolidado do chat, usando a primeira opção disponível: 1. Nome do lead (`lead_name`) 2. Nome completo do lead (`lead_fullName`) 3. Nome do contato no WhatsApp (`wa_contactName`) 4. Nome do perfil do WhatsApp (`wa_name`) - **`{{first_name}}`**: Primeira palavra válida do nome consolidado (mínimo 2 caracteres) ### Campos do WhatsApp - **`{{wa_name}}`**: Nome do perfil do WhatsApp - **`{{wa_contactName}}`**: Nome do contato como salvo no WhatsApp ### Campos do Lead - **`{{lead_name}}`**: Nome do lead - **`{{lead_fullName}}`**: Nome completo do lead - **`{{lead_personalid}}`**: ID pessoal (CPF, CNPJ, etc) - **`{{lead_email}}`**: Email do lead - **`{{lead_status}}`**: Status atual do lead - **`{{lead_notes}}`**: Anotações do lead - **`{{lead_assignedAttendant_id}}`**: ID do atendente designado ### Campos Personalizados Campos adicionados via custom fields são acessíveis usando `{{lead_field01}}` à `{{lead_field20}}` ou usar `{{nomedocampo}}` definido em `/instance/updateFieldsMap`. ### Exemplo de Uso ``` Olá {{name}}! Vi que você trabalha na {{company}}. Seu email {{lead_email}} está correto? ``` **💡 Dica**: Use `/chat/find` para buscar dados do chat e ver os campos disponíveis antes de enviar mensagens com placeholders. - name: Mensagem Async description: > Controles operacionais da fila interna de envio assíncrono usada quando um endpoint de envio recebe `async=true`. Esta seção serve para: - consultar o estado atual da fila async - configurar o delay entre mensagens enviadas com `async=true` - limpar backlog pendente e cancelar mensagens ainda não concluídas Escopo: - cobre apenas a fila interna de mensagens diretas async - não altera mensagens já enviadas com sucesso - name: Ações na mensagem e Buscar - name: Chats - name: Contatos - name: Bloqueios - name: Etiquetas - name: Grupos e Comunidades - name: Newsletters e Canais description: > Operações para leitura e acompanhamento de canais do WhatsApp (newsletters). Casos de uso principais: - listar posts já publicados em um canal - editar posts recentes de um canal - deletar posts recentes de um canal - consultar views e reações dos posts - integrar canais sem necessidade de persistir as mensagens localmente Observações: - `/newsletter/messages` retorna o conteúdo dos posts - `/newsletter/messages/edit` edita o conteúdo de posts recentes - `/newsletter/messages/delete` apaga posts recentes - views (`viewsCount`) e reactions (`reactionCounts`) vêm em cada post de `/newsletter/messages`, não por evento de webhook - `/newsletter/updates` está obsoleta: o WhatsApp não responde e a API devolve 504 - newsletters usam rotas próprias e não devem usar `/message/edit` ou `/message/delete` - name: Respostas Rápidas description: > Gerenciamento de respostas rápidas para agilizar o atendimento. **⚠️ Importante**: Este recurso tem serventia apenas se você utilizar um sistema frontend/interface personalizada para registrar e utilizar as respostas. A API apenas armazena as respostas, mas não as aplica automaticamente. ### Como funciona: - **Criar**: Cadastre respostas pré-definidas com títulos e conteúdo - **Listar**: Recupere todas as respostas cadastradas para exibir na sua interface - **Usar**: Seu sistema frontend pode usar essas respostas para agilizar digitação ### Casos de uso: - Interfaces web personalizadas de atendimento - Apps mobile com sugestões de resposta - Sistemas CRM com templates de mensagem - Ferramentas de produtividade para atendentes **Não é um chatbot**: Para respostas automáticas, use os recursos de Chatbot. - name: CRM description: > Sistema completo de gestão de relacionamento com clientes integrado à API. **💾 Armazenamento interno**: Todos os dados dos leads ficam salvos diretamente na API, eliminando a necessidade de bancos de dados externos. Sua aplicação pode focar apenas na interface e lógica de negócio. ### Recursos disponíveis: - **📋 20+ campos personalizáveis**: Nome, telefone, email, empresa, observações, etc. - **🏷️ Sistema de etiquetas**: Organize e categorize seus contatos - **🔍 Busca avançada**: Filtre por qualquer campo ou etiqueta - **📊 Histórico completo**: Todas as interações ficam registradas automaticamente ### 🎯 Placeholders em mensagens: Use variáveis dinâmicas nas mensagens para personalização automática: ``` Olá {{nome}}! Vi que você trabalha na {{empresa}}. Seu email {{email}} está correto? Observações: {{observacoes}} ``` ### Fluxo típico: 1. **Captura**: Leads chegam via WhatsApp ou formulários 2. **Enriquecimento**: Adicione dados usando `/chat/editLead` 3. **Segmentação**: Organize com etiquetas 4. **Comunicação**: Envie mensagens personalizadas com placeholders 5. **Acompanhamento**: Histórico fica salvo automaticamente **Ideal para**: Vendas, marketing, atendimento, qualificação de leads - name: Integração Chatwoot description: > **🚧 INTEGRAÇÃO BETA - Sistema de integração com Chatwoot para atendimento unificado** **⚠️ AVISO**: Esta integração está em fase BETA. Use por sua conta e risco. Recomendamos testes em ambiente não-produtivo antes do uso em produção. Esta categoria contém recursos para configurar e gerenciar a integração com o Chatwoot, uma plataforma de atendimento ao cliente open-source. A integração permite centralizar conversas do WhatsApp no Chatwoot. ### Recursos disponíveis: - 🔧 **Configuração Completa**: Configure URL, tokens e credenciais do Chatwoot - 📬 **Sincronização Bidirecional**: Mensagens novas entre WhatsApp e Chatwoot são sincronizadas automaticamente - 📱 **Gerenciamento de Contatos**: Sincronização automática de nomes e telefones - 🔄 **Atualização LID→PN**: Migração automática de Local ID para Phone Number - 🏷️ **Nomes Inteligentes**: Sistema de nomes com til (~) para atualização automática - 🚫 **Separação de Grupos**: Opção para ignorar grupos na sincronização - 👤 **Assinatura de Mensagens**: Identificação do agente nas mensagens enviadas - 🔗 **Webhook Automático**: URL gerada automaticamente para configurar no Chatwoot ### 🏷️ Sistema de Nomes Inteligentes: - **Nomes com til (~)**: Atualizados automaticamente quando contato modifica nome no WhatsApp - **Nomes específicos**: Para nome fixo, remover til (~) do nome no Chatwoot - **Exemplo**: "~João Silva" = automático, "João Silva" = fixo - **Migração LID→PN**: Sem duplicação de conversas durante a transição - **Respostas nativas**: Aparecem diretamente no Chatwoot sem marcações externas ### ⚠️ Limitações conhecidas: - **Sincronização de histórico**: Não implementada - apenas mensagens novas são sincronizadas ### Casos de uso: - Atendimento centralizado no Chatwoot - Equipes de suporte com múltiplos agentes - Integração com CRM via Chatwoot - Centralização de canais de comunicação - Gestão automática de contatos e nomes **Ideal para**: Empresas com equipes de atendimento, call centers, suporte técnico (em ambiente de testes) **Requer**: Instância do Chatwoot configurada, tokens de API e ambiente de testes **🚧 Lembre-se**: Integração em BETA - funcionalidades podem mudar sem aviso prévio - name: Server-Sent Events (SSE) paths: /message/find: post: tags: - Ações na mensagem e Buscar summary: Buscar mensagens em um chat description: > Busca mensagens com múltiplos filtros disponíveis. Este endpoint permite: 1. **Busca por ID específico**: Use `id` para encontrar uma mensagem exata 2. **Filtrar por chat**: Use `chatid` para mensagens de uma conversa específica 3. **Filtrar por rastreamento**: Use `track_source` e `track_id` para mensagens com dados de tracking 4. **Histórico de ligações**: Use apenas `messageType: call`, `limit` e `offset` para listar as chamadas mais recentes. A resposta pode trazer `callPeer` (identidade conhecida do contato) e `content.isVideo`. 5. **Status dos contatos**: Use `chatid: status@broadcast` para os Status recebidos, mesmo sem webhook `status_posts`. Sem esse `chatid`, a busca não traz Status. Eles ficam guardados por 24 horas, como no WhatsApp (a limpeza roda uma vez por dia, então filtre `messageTimestamp` se precisar do corte exato), e o Status que o autor apaga sai da lista. Cada um vem com o autor em `sender_pn`, `sender_lid` e `sender_image_preview_url` (foto, quando conhecida) e, nos de imagem, vídeo ou link, com a miniatura em `content.JPEGThumbnail`. Baixe a mídia pelo `/message/download`. Um Status que não abriu vem com `messageType: error` e só o ID, o autor e o horário. **Status de grupo** (enviados e recebidos) ficam na conversa de cada grupo com `messageType: GroupStatusMessage` e o texto em `text`: liste todos com `messageType: GroupStatusMessage`, sem `chatid`. Saem em 24 horas, como os outros Status. 6. **Limitar resultados**: Use `limit` para controlar quantas mensagens retornar 7. **Ordenação**: Resultados ordenados por data (mais recentes primeiro) Fora dos Status, as mensagens guardadas só trazem no `content` as miniaturas em base64 que não têm cópia no servidor (prévia de link sem cópia, localização, anúncio, convites); as de mídia que pode ser baixada de novo (`JPEGThumbnail` e afins) chegam só no webhook, na hora da mensagem. Nas mensagens enviadas pela API nos últimos 7 dias, `sendPayload` traz o pedido de envio, sem os arquivos em base64 (links vêm). Depois do envio (em conversa individual, 1 hora depois), o arquivo em base64 guardado vira o texto `[arquivo removido após o envio: tipo, N bytes]`. requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: ID específico da mensagem para busca exata example: user123:r3EB0538 chatid: type: string description: ID do chat no formato internacional example: 5511999999999@s.whatsapp.net messageType: type: string description: >- Tipo da mensagem. Use `call` com `limit` e `offset` para o histórico de ligações. example: call track_source: type: string description: Origem do rastreamento para filtrar mensagens example: chatwoot track_id: type: string description: ID de rastreamento para filtrar mensagens example: msg_123456789 limit: type: integer description: >- Número máximo de mensagens a retornar (padrão 100, sem máximo). Para muitas mensagens, prefira páginas de até 1000 e avance com `pagination.nextOffset`. minimum: 1 default: 100 example: 20 offset: type: integer description: >- Deslocamento para paginacao (0 retorna as mensagens mais recentes) default: 0 examples: chatSearch: summary: Buscar por chat especifico description: Busca mensagens de uma conversa especifica value: chatid: 5511999999999@s.whatsapp.net limit: 20 offset: 0 idSearch: summary: Buscar por ID especifico description: Busca uma mensagem especifica pelo seu ID value: id: user123:r3EB0538 trackingSearch: summary: Buscar por rastreamento description: Busca mensagens usando dados de tracking com paginacao value: track_source: chatwoot track_id: conv_123456 limit: 50 offset: 100 callHistory: summary: Histórico de ligações value: messageType: call limit: 40 offset: 0 responses: '200': description: Lista de mensagens encontradas com metadados de paginacao content: application/json: schema: type: object properties: messages: type: array items: $ref: '#/components/schemas/Message' pagination: type: object description: >- Dados da página, como nas outras listas, sem `totalRecords` (contar as mensagens pesaria a cada página). properties: limit: type: integer offset: type: integer hasMore: type: boolean description: Há mais mensagens depois desta página. nextOffset: type: integer description: Offset da próxima página. '400': description: Parametros invalidos '401': description: Token invalido ou expirado '404': description: Chat nao encontrado '500': description: Erro interno do servidor components: schemas: Message: type: object description: Representa uma mensagem trocada no sistema properties: id: type: string format: uuid description: >- ID único interno da mensagem (formato r + 7 caracteres hex aleatórios) messageid: type: string description: ID original da mensagem no provedor chatid: type: string description: ID da conversa relacionada sender: type: string description: ID do remetente da mensagem senderName: type: string description: Nome exibido do remetente isGroup: type: boolean description: Indica se é uma mensagem de grupo default: false fromMe: type: boolean description: Indica se a mensagem foi enviada pelo usuário default: false messageType: type: string description: Tipo de conteúdo da mensagem source: type: string description: Plataforma de origem da mensagem messageTimestamp: type: integer description: Timestamp original da mensagem em milissegundos default: 0 status: type: string description: > Status do ciclo de vida da mensagem. Exemplos comuns: `Queued`, `Canceled`, `Failed`, `Sent`, `Delivered`, `Read`. Em mensagem de grupo, segue o participante mais adiantado: `Delivered` quando pelo menos um recebeu, `Read` quando pelo menos um leu e `Played` quando pelo menos um ouviu. text: type: string description: Texto original da mensagem default: '' quoted: type: string description: ID da mensagem citada/respondida default: '' edited: type: string description: Histórico de edições da mensagem default: '' reaction: type: string description: ID da mensagem reagida default: '' vote: type: string description: Dados de votação de enquete e listas default: '' convertOptions: type: string description: Conversão de opções da mensagem, lista, enquete e botões default: '' buttonOrListid: type: string description: ID do botão ou item de lista selecionado default: '' owner: type: string description: Dono da mensagem default: '' error: type: string description: Mensagem de erro caso o envio tenha falhado default: '' content: description: Conteúdo bruto da mensagem (JSON serializado ou texto) oneOf: - type: object additionalProperties: true - type: string description: Texto bruto quando não for JSON wasSentByApi: type: boolean description: Indica se a mensagem foi enviada via API pinned: type: boolean description: >- Mensagem fixada na conversa (fixar e desafixar chegam também em `messages_update`, tipos `Pinned` e `Unpinned`) sendFunction: type: string description: Função usada para enviar a mensagem (quando enviada via API) sendPayload: description: >- Payload usado no envio quando disponível. Dados de mídia em base64 são omitidos. oneOf: - type: object additionalProperties: true - type: string description: Texto bruto quando não for JSON fileURL: type: string description: URL ou referência de arquivo da mensagem callPeer: type: object description: >- Contato conhecido associado a uma ligação, quando disponível em `messageType: call`. properties: jid: type: string name: type: string imagePreviewUrl: type: string send_folder_id: type: string description: Pasta associada ao envio (quando aplicável) track_source: type: string description: Origem de rastreamento track_id: type: string description: ID de rastreamento (pode repetir) ai_metadata: type: object description: >- Registro de uma rodada da IA. O completo (pedido ao modelo, resposta e `outcome`) fica uma vez, na última mensagem do contato que a rodada respondeu, também quando nada saiu (erro, resposta descartada). Cada mensagem enviada pela IA leva só `agent_id` e `turn` (o `id` dessa mensagem do contato). properties: agent_id: type: string description: ID do agente de IA responsável turn: type: string description: >- Na mensagem enviada pela IA: o `id` da mensagem do contato onde está o registro completo da rodada. flow_id: type: string description: >- Mensagem enviada por um fluxo: o `id` do fluxo. A mensagem enviada pela IA traz o `agent_id`. request: type: object description: Dados da requisição à API de IA properties: messages: type: array description: Histórico de mensagens enviadas para a API tools: type: array description: Ferramentas disponíveis para o agente options: type: object description: Opções de configuração da API properties: model: type: string temperature: type: number maxTokens: type: integer topP: type: number frequencyPenalty: type: number presencePenalty: type: number response: type: object description: Resposta da API de IA properties: choices: type: array description: Resultados retornados pela API toolResults: type: array description: Resultados da execução de ferramentas error: type: string description: Mensagem de erro, se houver outcome: type: object description: O que a rodada fez de fato (só no registro completo). properties: status: type: string enum: - sent - cancelled - error - empty description: >- `sent`: enviou algo; `cancelled`: descartada (a conversa pausou, um fluxo começou ou bateu o limite de respostas por hora); `error`: o provedor falhou; `empty`: nada a enviar. texts: type: integer description: Mensagens de texto enviadas. audio: type: boolean description: Respondeu em áudio. menus: type: integer description: Menus enviados. files: type: integer description: Arquivos (mensagens cadastradas) enviados. handoff: type: string description: '`chamar_humano`: o resumo para quem atender.' lead: type: array items: type: string description: >- `atualizar_lead`: o que foi gravado no CRM (`lead_email = ana@exemplo.com; column = Agendado`). detail: type: string description: Por que foi descartada, ou o erro. sender_pn: description: JID PN resolvido do remetente (quando disponível) oneOf: - type: string - type: 'null' sender_lid: description: LID original do remetente (quando disponível) oneOf: - type: string - type: 'null' sender_image_preview_url: type: string format: uri description: >- URL temporária de preview do remetente, quando conhecida. A hidratação desta versão preenche mensagens recebidas em grupos; o campo pode ser omitido. Não provoca consulta de foto ao WhatsApp na listagem. securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.