# WppFy ## Docs - [Apagar Mensagem Para Todos](https://docs.wppfy.com/api-reference/ações-na-mensagem-e-buscar/apagar-mensagem-para-todos.md): Apaga uma mensagem para todos os participantes da conversa. - [Baixar arquivo de uma mensagem](https://docs.wppfy.com/api-reference/ações-na-mensagem-e-buscar/baixar-arquivo-de-uma-mensagem.md): Baixa o arquivo associado a uma mensagem de mídia (imagem, vídeo, áudio, documento ou sticker). - [Buscar mensagens em um chat](https://docs.wppfy.com/api-reference/ações-na-mensagem-e-buscar/buscar-mensagens-em-um-chat.md): Busca mensagens com múltiplos filtros disponíveis. Este endpoint permite: - [Edita uma mensagem enviada](https://docs.wppfy.com/api-reference/ações-na-mensagem-e-buscar/edita-uma-mensagem-enviada.md): Edita o conteúdo de uma mensagem já enviada usando a funcionalidade nativa do WhatsApp. - [Enviar reação a uma mensagem](https://docs.wppfy.com/api-reference/ações-na-mensagem-e-buscar/enviar-reação-a-uma-mensagem.md): Envia uma reação (emoji) a uma mensagem específica. Este endpoint permite: - [Marcar mensagens como lidas](https://docs.wppfy.com/api-reference/ações-na-mensagem-e-buscar/marcar-mensagens-como-lidas.md): Marca uma ou mais mensagens como lidas. Este endpoint permite: 1. Marcar múltiplas mensagens como lidas de uma vez 2. Atualizar o status de leitura no WhatsApp 3. Sincronizar o status de leitura entre dispositivos - [Bloqueia ou desbloqueia contato do WhatsApp](https://docs.wppfy.com/api-reference/bloqueios/bloqueia-ou-desbloqueia-contato-do-whatsapp.md): Bloqueia ou desbloqueia um contato do WhatsApp. Contatos bloqueados não podem enviar mensagens para a instância e a instância não pode enviar mensagens para eles. - [Lista contatos bloqueados](https://docs.wppfy.com/api-reference/bloqueios/lista-contatos-bloqueados.md): Retorna a lista completa de contatos que foram bloqueados pela instância. Esta lista é atualizada em tempo real conforme contatos são bloqueados/desbloqueados. - [Iniciar chamada de voz](https://docs.wppfy.com/api-reference/chamadas/iniciar-chamada-de-voz.md): Inicia uma chamada de voz para um contato específico. Este endpoint permite: 1. Iniciar chamadas de voz para contatos 2. Funciona apenas com números válidos do WhatsApp 3. O contato receberá uma chamada de voz - [Rejeitar chamada recebida](https://docs.wppfy.com/api-reference/chamadas/rejeitar-chamada-recebida.md): Rejeita uma chamada recebida do WhatsApp. Este endpoint permite: 1. Rejeitar chamadas de voz ou vídeo recebidas 2. Necessita do número do contato que está ligando 3. Necessita do ID da chamada para identificação - [Chatbot Configurações](https://docs.wppfy.com/api-reference/chatbot-configurações/chatbot-configurações.md): Explicação dos campos: - [Criar, atualizar ou excluir um trigger do chatbot](https://docs.wppfy.com/api-reference/chatbot-trigger/criar-atualizar-ou-excluir-um-trigger-do-chatbot.md): Endpoint para gerenciar triggers do chatbot. Suporta: - Criação de novos triggers - Atualização de triggers existentes - Exclusão de triggers por ID - [Listar todos os triggers do chatbot](https://docs.wppfy.com/api-reference/chatbot-trigger/listar-todos-os-triggers-do-chatbot.md): Retorna a lista completa de triggers configurados para a instância atual - [Arquivar/desarquivar chat](https://docs.wppfy.com/api-reference/chats/arquivardesarquivar-chat.md): Altera o estado de arquivamento de um chat do WhatsApp. - Quando arquivado, o chat é movido para a seção de arquivados no WhatsApp - A ação é sincronizada entre todos os dispositivos conectados - Não afeta as mensagens ou o conteúdo do chat - [Busca chats com filtros](https://docs.wppfy.com/api-reference/chats/busca-chats-com-filtros.md): Busca chats com diversos filtros e ordenação. Suporta filtros em todos os campos do chat, paginação e ordenação customizada. - [Deleta chat](https://docs.wppfy.com/api-reference/chats/deleta-chat.md): Deleta um chat e/ou suas mensagens do WhatsApp e/ou banco de dados. Você pode escolher deletar: - Apenas do WhatsApp - Apenas do banco de dados - Apenas as mensagens do banco de dados - Qualquer combinação das opções acima - [Fixar/desafixar chat](https://docs.wppfy.com/api-reference/chats/fixardesafixar-chat.md): Fixa ou desafixa um chat no topo da lista de conversas. Chats fixados permanecem no topo mesmo quando novas mensagens são recebidas em outros chats. - [Marcar chat como lido/não lido](https://docs.wppfy.com/api-reference/chats/marcar-chat-como-lidonão-lido.md): Atualiza o status de leitura de um chat no WhatsApp. - [Silenciar chat](https://docs.wppfy.com/api-reference/chats/silenciar-chat.md): Silencia notificações de um chat por um período específico. As opções de silenciamento são: * 0 - Remove o silenciamento * 8 - Silencia por 8 horas * 168 - Silencia por 1 semana (168 horas) * -1 - Silencia permanentemente - [Criar/Editar Agente](https://docs.wppfy.com/api-reference/configuração-do-agente-de-ia/criareditar-agente.md): # Documentação dos Campos de Configuração - [Todos os agentes](https://docs.wppfy.com/api-reference/configuração-do-agente-de-ia/todos-os-agentes.md) - [Criar/Editar Conhecimento do Agente](https://docs.wppfy.com/api-reference/conhecimento-dos-agentes/criareditar-conhecimento-do-agente.md): Gerencia o conhecimento base usado pelos agentes de IA para responder consultas. O conhecimento pode ser fornecido como texto direto ou através de arquivos PDF/CSV. - [Listar Base de Conhecimento](https://docs.wppfy.com/api-reference/conhecimento-dos-agentes/listar-base-de-conhecimento.md): Retorna todos os conhecimentos cadastrados para o agente de IA da instância. Estes conhecimentos são utilizados pelo chatbot para responder perguntas e interagir com os usuários de forma contextualizada. - [Adiciona um contato à agenda](https://docs.wppfy.com/api-reference/contatos/adiciona-um-contato-à-agenda.md): Adiciona um novo contato à agenda do celular. - [Listar todos os contatos com paginacao](https://docs.wppfy.com/api-reference/contatos/listar-todos-os-contatos-com-paginacao.md): Retorna uma lista paginada de contatos da instancia do WhatsApp. Use este endpoint (POST) para controlar pagina, tamanho e offset via corpo da requisicao. A rota GET `/contacts` continua disponivel para quem prefere a lista completa sem paginacao. - [Obter Detalhes Completos](https://docs.wppfy.com/api-reference/contatos/obter-detalhes-completos.md): Retorna informações **completas** sobre um contato ou chat, incluindo **todos os campos disponíveis** do modelo Chat. - [Remove um contato da agenda](https://docs.wppfy.com/api-reference/contatos/remove-um-contato-da-agenda.md): Remove um contato da agenda do celular. - [Retorna lista de contatos do WhatsApp](https://docs.wppfy.com/api-reference/contatos/retorna-lista-de-contatos-do-whatsapp.md): Retorna a lista de contatos salvos na agenda do celular e que estão no WhatsApp. - [Verificar Números no WhatsApp](https://docs.wppfy.com/api-reference/contatos/verificar-números-no-whatsapp.md): Verifica se números fornecidos estão registrados no WhatsApp e retorna informações detalhadas. - [Atualizar campos personalizados de leads](https://docs.wppfy.com/api-reference/crm/atualizar-campos-personalizados-de-leads.md): Atualiza os campos personalizados (custom fields) de uma instância. Permite configurar até 20 campos personalizados para armazenamento de informações adicionais sobre leads. - [Edita informações de lead](https://docs.wppfy.com/api-reference/crm/edita-informações-de-lead.md): Atualiza as informações de lead associadas a um chat. Permite modificar status do ticket, atribuição de atendente, posição no kanban, tags e outros campos customizados. - [Enviar atualização de presença](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-atualização-de-presença.md): Envia uma atualização de presença para um contato ou grupo de forma **assíncrona**. - [Enviar botão PIX](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-botão-pix.md): Envia um botão nativo do WhatsApp que abre para pagamento PIX com a chave informada. O usuário visualiza o detalhe do recebedor, nome e chave. - [Enviar carrossel de mídia com botões](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-carrossel-de-mídia-com-botões.md): Este endpoint permite enviar um carrossel com imagens e botões interativos. Funciona de maneira igual ao endpoint `/send/menu` com type: carousel, porém usando outro formato de payload. - [Enviar cartão de contato (vCard)](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-cartão-de-contato-vcard.md): Envia um cartão de contato (vCard) para um contato ou grupo. - [Enviar localização geográfica](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-localização-geográfica.md): Envia uma localização geográfica para um contato ou grupo. - [Enviar mensagem de texto](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-mensagem-de-texto.md): Envia uma mensagem de texto para um contato ou grupo. - [Enviar menu interativo (botões, carrosel, lista ou enquete)](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-menu-interativo-botões-carrosel-lista-ou-enquete.md): Este endpoint oferece uma interface unificada para envio de quatro tipos principais de mensagens interativas: - Botões: Para ações rápidas e diretas - Carrosel de Botões: Para uma lista horizontal de botões com imagens - Listas: Para menus organizados em seções - Enquetes: Para coleta de opiniões e… - [Enviar mídia (imagem, vídeo, áudio ou documento)](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-mídia-imagem-vídeo-áudio-ou-documento.md): Envia diferentes tipos de mídia para um contato ou grupo. Suporta URLs ou arquivos base64. - [Enviar Stories (Status)](https://docs.wppfy.com/api-reference/enviar-mensagem/enviar-stories-status.md): Envia um story (status) com suporte para texto, imagem, vídeo e áudio. - [Solicitar localização do usuário](https://docs.wppfy.com/api-reference/enviar-mensagem/solicitar-localização-do-usuário.md): Este endpoint envia uma mensagem com um botão que solicita a localização do usuário. Quando o usuário clica no botão, o WhatsApp abre a interface para compartilhar a localização atual. - [Solicitar pagamento](https://docs.wppfy.com/api-reference/enviar-mensagem/solicitar-pagamento.md): Envia uma solicitação de pagamento com o botão nativo **"Revisar e pagar"** do WhatsApp. O fluxo suporta PIX (estático, dinâmico ou desabilitado), boleto, link de pagamento e cartão, combinando tudo em uma única mensagem interativa. - [Buscar todas as etiquetas](https://docs.wppfy.com/api-reference/etiquetas/buscar-todas-as-etiquetas.md): Retorna a lista completa de etiquetas da instância. - [Editar etiqueta](https://docs.wppfy.com/api-reference/etiquetas/editar-etiqueta.md): Edita uma etiqueta existente na instância. Permite alterar nome, cor ou deletar a etiqueta. - [Gerencia labels de um chat](https://docs.wppfy.com/api-reference/etiquetas/gerencia-labels-de-um-chat.md): Atualiza as labels associadas a um chat específico. Este endpoint oferece três modos de operação: - [Criar/Editar função para integração com APIs externas](https://docs.wppfy.com/api-reference/funções-api-dos-agentes/criareditar-função-para-integração-com-apis-externas.md): # Configuração de Funções de API para Agentes IA - [Lista todas as funções de API](https://docs.wppfy.com/api-reference/funções-api-dos-agentes/lista-todas-as-funções-de-api.md): Retorna todas as funções de API configuradas para a instância atual - [Atualizar descrição do grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/atualizar-descrição-do-grupo.md): Altera a descrição (tópico) do grupo WhatsApp especificado. Requer que o usuário seja administrador do grupo. A descrição aparece na tela de informações do grupo e pode ser visualizada por todos os participantes. - [Atualizar imagem do grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/atualizar-imagem-do-grupo.md): Altera a imagem do grupo especificado. A imagem pode ser enviada como URL ou como string base64. - [Atualizar nome do grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/atualizar-nome-do-grupo.md): Altera o nome de um grupo do WhatsApp. Apenas administradores do grupo podem realizar esta operação. O nome do grupo deve seguir as diretrizes do WhatsApp e ter entre 1 e 25 caracteres. - [Configurar permissão de edição do grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/configurar-permissão-de-edição-do-grupo.md): Define se apenas administradores podem editar as informações do grupo. Quando bloqueado (locked=true), apenas administradores podem alterar nome, descrição, imagem e outras configurações do grupo. Quando desbloqueado (locked=false), qualquer participante pode editar as informações. - [Configurar permissões de envio de mensagens no grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/configurar-permissões-de-envio-de-mensagens-no-grupo.md): Define as permissões de envio de mensagens no grupo, permitindo restringir o envio apenas para administradores. - [Criar um novo grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/criar-um-novo-grupo.md): Cria um novo grupo no WhatsApp com participantes iniciais. - [Criar uma comunidade](https://docs.wppfy.com/api-reference/grupos-e-comunidades/criar-uma-comunidade.md): Cria uma nova comunidade no WhatsApp. Uma comunidade é uma estrutura que permite agrupar múltiplos grupos relacionados sob uma única administração. - [Entrar em um grupo usando código de convite](https://docs.wppfy.com/api-reference/grupos-e-comunidades/entrar-em-um-grupo-usando-código-de-convite.md): Permite entrar em um grupo do WhatsApp usando um código de convite ou URL completo. - [Gerar link de convite para um grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/gerar-link-de-convite-para-um-grupo.md): Retorna o link de convite para o grupo especificado. Esta operação requer que o usuário seja um administrador do grupo. - [Gerenciar grupos em uma comunidade](https://docs.wppfy.com/api-reference/grupos-e-comunidades/gerenciar-grupos-em-uma-comunidade.md): Adiciona ou remove grupos de uma comunidade do WhatsApp. Apenas administradores da comunidade podem executar estas operações. - [Gerenciar participantes do grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/gerenciar-participantes-do-grupo.md): Gerencia participantes do grupo através de diferentes ações: - Adicionar ou remover participantes - Promover ou rebaixar administradores - Aprovar ou rejeitar solicitações pendentes - [Listar todos os grupos](https://docs.wppfy.com/api-reference/grupos-e-comunidades/listar-todos-os-grupos.md): Retorna uma lista com todos os grupos disponíveis para a instância atual do WhatsApp. - [Listar todos os grupos com filtros e paginacao](https://docs.wppfy.com/api-reference/grupos-e-comunidades/listar-todos-os-grupos-com-filtros-e-paginacao.md): Retorna uma lista com todos os grupos disponiveis para a instancia atual do WhatsApp, com opcoes de filtros e paginacao via corpo (POST). A rota GET continua para quem prefere a listagem direta sem paginacao. - [Obter informações de um grupo pelo código de convite](https://docs.wppfy.com/api-reference/grupos-e-comunidades/obter-informações-de-um-grupo-pelo-código-de-convite.md): Retorna informações detalhadas de um grupo usando um código de convite ou URL completo do WhatsApp. - [Obter informações detalhadas de um grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/obter-informações-detalhadas-de-um-grupo.md): Recupera informações completas de um grupo do WhatsApp, incluindo: - Detalhes do grupo - Participantes - Configurações - Link de convite (opcional) - [Resetar código de convite do grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/resetar-código-de-convite-do-grupo.md): Gera um novo código de convite para o grupo, invalidando o código de convite anterior. Somente administradores do grupo podem realizar esta ação. - [Sair de um grupo](https://docs.wppfy.com/api-reference/grupos-e-comunidades/sair-de-um-grupo.md): Remove o usuário atual de um grupo específico do WhatsApp. - [Atualizar nome da instância](https://docs.wppfy.com/api-reference/instancia/atualizar-nome-da-instância.md): Atualiza o nome de uma instância WhatsApp existente. O nome não precisa ser único. - [Atualizar status de presença da instância](https://docs.wppfy.com/api-reference/instancia/atualizar-status-de-presença-da-instância.md): Atualiza o status de presença global da instância do WhatsApp. Este endpoint permite: 1. Definir se a instância está disponível (Aparece "online") ou indisponível 2. Controlar o status de presença para todos os contatos 3. Salvar o estado atual da presença na instância - [Conectar instância ao WhatsApp](https://docs.wppfy.com/api-reference/instancia/conectar-instância-ao-whatsapp.md): Espanhol Inicia o processo de conexão de uma instância ao WhatsApp. Este endpoint: 1. Requer o token de autenticação da instância 2. Recebe o número de telefone associado à conta WhatsApp 3. Gera um QR code caso não passe o campo `phone` 4. Ou Gera código de pareamento se passar o o campo `phone` 5.… - [Deletar instância](https://docs.wppfy.com/api-reference/instancia/deletar-instância.md): Remove a instância do sistema. - [Desconectar instância](https://docs.wppfy.com/api-reference/instancia/desconectar-instância.md): Desconecta a instância do WhatsApp, encerrando a sessão atual. Esta operação: - [Verificar status da instância](https://docs.wppfy.com/api-reference/instancia/verificar-status-da-instância.md): Retorna o status atual de uma instância, incluindo: - Estado da conexão (disconnected, connecting, connected) - QR code atualizado (se em processo de conexão) - Código de pareamento (se disponível) - Informações da última desconexão - Detalhes completos da instância - [Atualizar configuração do Chatwoot](https://docs.wppfy.com/api-reference/integração-chatwoot/atualizar-configuração-do-chatwoot.md): Atualiza a configuração da integração com Chatwoot para a instância. - [Obter configuração do Chatwoot](https://docs.wppfy.com/api-reference/integração-chatwoot/obter-configuração-do-chatwoot.md): Retorna a configuração atual da integração com Chatwoot para a instância. - [Controlar campanha de envio em massa](https://docs.wppfy.com/api-reference/mensagem-em-massa/controlar-campanha-de-envio-em-massa.md): Permite controlar campanhas de envio de mensagens em massa através de diferentes ações: - [Criar envio em massa avançado](https://docs.wppfy.com/api-reference/mensagem-em-massa/criar-envio-em-massa-avançado.md): Cria um novo envio em massa com configurações avançadas, permitindo definir múltiplos destinatários e mensagens com delays personalizados. - [Criar nova campanha (Simples)](https://docs.wppfy.com/api-reference/mensagem-em-massa/criar-nova-campanha-simples.md): Cria uma nova campanha de envio com configurações básicas - [Limpar mensagens enviadas](https://docs.wppfy.com/api-reference/mensagem-em-massa/limpar-mensagens-enviadas.md): Inicia processo de limpeza de mensagens antigas em lote que já foram enviadas com sucesso. Por padrão, remove mensagens mais antigas que 7 dias. - [Limpar toda fila de mensagens](https://docs.wppfy.com/api-reference/mensagem-em-massa/limpar-toda-fila-de-mensagens.md): Remove todas as mensagens da fila de envio em massa, incluindo mensagens pendentes e já enviadas. Esta é uma operação irreversível. - [Listar campanhas de envio](https://docs.wppfy.com/api-reference/mensagem-em-massa/listar-campanhas-de-envio.md): Retorna todas as campanhas de mensagens em massa com possibilidade de filtro por status - [Listar mensagens de uma campanha](https://docs.wppfy.com/api-reference/mensagem-em-massa/listar-mensagens-de-uma-campanha.md): Retorna a lista de mensagens de uma campanha específica, com opções de filtro por status e paginação - [Altera a imagem do perfil do WhatsApp](https://docs.wppfy.com/api-reference/perfil/altera-a-imagem-do-perfil-do-whatsapp.md): Altera a imagem de perfil da instância do WhatsApp. - [Altera o nome do perfil do WhatsApp](https://docs.wppfy.com/api-reference/perfil/altera-o-nome-do-perfil-do-whatsapp.md): Altera o nome de exibição do perfil da instância do WhatsApp. - [Criar, atualizar ou excluir resposta rápida](https://docs.wppfy.com/api-reference/respostas-rápidas/criar-atualizar-ou-excluir-resposta-rápida.md): Gerencia templates de respostas rápidas para agilizar o atendimento. Suporta mensagens de texto e mídia. - [Listar todas as respostas rápidas](https://docs.wppfy.com/api-reference/respostas-rápidas/listar-todas-as-respostas-rápidas.md): Retorna todas as respostas rápidas cadastradas para a instância autenticada - [Server-Sent Events (SSE)](https://docs.wppfy.com/api-reference/server-sent-events-sse/server-sent-events-sse.md): Receber eventos em tempo real via Server-Sent Events (SSE) - [Comece Aqui](https://docs.wppfy.com/pt-BR/api-reference/comece-aqui.md): API potente para gestão de instâncias e automações no WhatsApp. Conecte-se, envie mensagens e gerencie eventos facilmente. - [Configurar Webhook](https://docs.wppfy.com/pt-BR/api-reference/webhooks.md): Receba eventos em tempo real da sua instância via Webhook. ## OpenAPI Specs - [openapi-pt-BR](https://docs.wppfy.com/openapi-pt-BR.json) - [openapi-en](https://docs.wppfy.com/openapi-en.json)