> ## 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. # Conectar instância ao WhatsApp > Inicia a conexão da instância com o WhatsApp. - Sem `phone`, retorna um QR Code para leitura no celular. - Com `phone`, retorna um código de pareamento para esse número. A instância permanece em `connecting` até o pareamento ser confirmado ou o prazo expirar. Acompanhe a evolução em `GET /instance/status`; não repita a chamada enquanto o processo estiver em andamento. Após a conexão, o histórico disponível começa a chegar pelo evento `history` e pode ser consultado em `POST /message/find` e `POST /chat/find`. A resposta pode incluir `request_id` no topo, antes mesmo da leitura do QR code ou do código de pareamento. Guarde esse id para correlacionar a tentativa com os lotes `history` do pareamento, inclusive o `status` de conclusão, e com `GET /instance/history-sync/status`. Ele permanece igual durante a mesma tentativa e muda a cada novo pareamento. Pode estar ausente quando não há pareamento nem rastreamento disponível. Em um pareamento novo, `history_days` escolhe quantos dias de histórico o celular envia. Sem o campo, com valor fora de 0–365 ou de 1 a 90 dias, o pedido é o histórico normal (90 dias, quando não há um valor válido). De 91 a 365 dias, ou com `0` (o máximo, 365 dias), o pedido é o histórico completo, maior e mais demorado. Uma instância já pareada reconecta sem pedir histórico. Para escolher uma região de conexão, consulte primeiro `GET /proxy-managed/countries` e `GET /proxy-managed/cities` e reutilize os valores retornados nos campos `proxy_managed_*`. ## OpenAPI ````yaml /openapi-pt-BR.json post /instance/connect 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: /instance/connect: post: tags: - Instancia summary: Conectar instância ao WhatsApp description: > Inicia a conexão da instância com o WhatsApp. - Sem `phone`, retorna um QR Code para leitura no celular. - Com `phone`, retorna um código de pareamento para esse número. A instância permanece em `connecting` até o pareamento ser confirmado ou o prazo expirar. Acompanhe a evolução em `GET /instance/status`; não repita a chamada enquanto o processo estiver em andamento. Após a conexão, o histórico disponível começa a chegar pelo evento `history` e pode ser consultado em `POST /message/find` e `POST /chat/find`. A resposta pode incluir `request_id` no topo, antes mesmo da leitura do QR code ou do código de pareamento. Guarde esse id para correlacionar a tentativa com os lotes `history` do pareamento, inclusive o `status` de conclusão, e com `GET /instance/history-sync/status`. Ele permanece igual durante a mesma tentativa e muda a cada novo pareamento. Pode estar ausente quando não há pareamento nem rastreamento disponível. Em um pareamento novo, `history_days` escolhe quantos dias de histórico o celular envia. Sem o campo, com valor fora de 0–365 ou de 1 a 90 dias, o pedido é o histórico normal (90 dias, quando não há um valor válido). De 91 a 365 dias, ou com `0` (o máximo, 365 dias), o pedido é o histórico completo, maior e mais demorado. Uma instância já pareada reconecta sem pedir histórico. Para escolher uma região de conexão, consulte primeiro `GET /proxy-managed/countries` e `GET /proxy-managed/cities` e reutilize os valores retornados nos campos `proxy_managed_*`. requestBody: required: false content: application/json: schema: type: object properties: phone: type: string description: >- Número de telefone no formato internacional (ex: 5511999999999). Se informado, gera código de pareamento. Se omitido, gera QR code. example: '5511999999999' pattern: ^\d{10,15}$ browser: type: string description: >- Browser usado no ciclo de autenticação/conexão. `auto` preserva um perfil válido já salvo ou escolhe Safari, Firefox ou Edge para novas conexões. enum: - auto - safari - firefox - edge - chrome default: auto example: auto systemName: type: string description: >- Sistema/nome exibido no celular em aparelhos conectados. Ajuda a identificar a instância no WhatsApp; para maior estabilidade, recomendamos deixar em branco e usar o valor padrão do navegador escolhido. example: Minha Empresa proxy_managed_country: type: string description: >- País desejado para o proxy regional, em ISO alpha-2 minúsculo. Use o valor retornado por `GET /proxy-managed/countries`. example: br pattern: ^[a-z]{2}$ proxy_managed_state: type: string description: >- Estado/subdivisão da cidade escolhida. Quando o país/cidade exigir desambiguação, use o campo `state` retornado por `GET /proxy-managed/cities?country=br`. example: sp proxy_managed_city: type: string description: >- Cidade escolhida para o proxy regional. Use sempre o campo `value` retornado por `GET /proxy-managed/cities`. example: campinas history_days: type: integer minimum: 0 maximum: 365 default: 90 description: > Dias de histórico pedidos ao celular no pareamento. - Ausente: 90 dias, pelo histórico normal. - De `1` a `90`: os últimos N dias, pelo histórico normal. - De `91` a `365`: os últimos N dias, pelo histórico completo. - `0`: o máximo, 365 dias pelo histórico completo. - Fora de 0–365: ignorado; valem os 90 dias. Só vale em um pareamento novo. Uma instância já pareada reconecta sem pedir histórico, e um QR code ou código já gerado segue com o que foi pedido. O celular decide o que envia: os dias são um limite pedido, não uma garantia. example: 90 examples: qr_code_brasil_com_proxy_regional: summary: QR code com proxy regional em Campinas/SP value: browser: auto systemName: Minha Empresa proxy_managed_country: br proxy_managed_state: sp proxy_managed_city: campinas codigo_com_um_ano_de_historico: summary: Código de pareamento pedindo 1 ano de histórico value: phone: '5511999999999' history_days: 365 responses: '200': description: Sucesso content: application/json: schema: type: object properties: connected: type: boolean description: Estado atual da conexão example: false loggedIn: type: boolean description: Estado do login example: false jid: type: - object - 'null' description: ID do WhatsApp (quando logado) example: null instance: $ref: '#/components/schemas/Instance' description: Detalhes completos da instância request_id: type: string description: >- Identificador da tentativa de pareamento e de seu histórico inicial. Opcional; é o mesmo informado nos eventos history e em GET /instance/history-sync/status. example: 5f0c2a8e-6d1b-4c3a-9e7f-1a2b3c4d5e6f examples: pareamento_em_andamento: summary: Tentativa de pareamento com histórico correlacionado value: response: Connecting request_id: 5f0c2a8e-6d1b-4c3a-9e7f-1a2b3c4d5e6f status: connected: false loggedIn: false jid: null '401': description: Token inválido/expirado '404': description: Instância não encontrada '409': description: Já existe um fluxo de conexão em andamento para a instância '429': description: Limite de conexões simultâneas atingido '500': description: Erro interno '503': description: Capacidade de conexão temporariamente indisponível headers: Retry-After: description: Tempo recomendado, em segundos, para tentar novamente. schema: type: integer example: 5 components: schemas: Instance: type: object description: Representa uma instância do WhatsApp properties: id: type: string description: Identificador opaco gerado pelo servidor. Não presuma formato UUID. token: type: string description: Token de autenticação da instância status: type: string description: Status atual da conexão enum: - disconnected - connecting - connected - hibernated paircode: type: string description: Código de pareamento qrcode: type: string description: QR Code em base64 para autenticação name: type: string description: Nome da instância profileName: type: string description: Nome do perfil WhatsApp profilePicUrl: type: string format: uri description: URL da foto do perfil isBusiness: type: boolean description: Indica se é uma conta business plataform: type: string description: Plataforma de origem (iOS/Android/Web) systemName: type: string description: Nome do sistema operacional owner: type: string description: Proprietário da instância current_presence: type: string description: Status atual de presença da instância (campo não persistido) enum: - available - unavailable example: available lastDisconnect: type: string description: Data/hora textual da última desconexão lastDisconnectReason: type: string description: Motivo da última desconexão adminField01: type: string description: Campo administrativo 01 adminField02: type: string description: Campo administrativo 02 openai_apikey: type: string description: Chave da API OpenAI chatbot_enabled: type: boolean description: Habilitar chatbot automático chatbot_ignoreGroups: type: boolean description: Ignorar mensagens de grupos chatbot_stopConversation: type: string description: Palavra-chave para parar conversa chatbot_stopMinutes: type: integer description: Por quanto tempo ficará pausado o chatbot ao usar stop conversation chatbot_stopWhenYouSendMsg: type: integer description: >- Por quanto tempo ficará pausada a conversa quando você enviar mensagem manualmente fieldsMap: type: object description: Mapa de campos customizados da instância (quando presente) additionalProperties: true currentTime: type: string description: Horário atual retornado pela API created: type: string description: >- Data de criação retornada pela API. Trate o valor como texto; o formato pode variar. updated: type: string description: >- Data da última atualização retornada pela API. Trate o valor como texto; o formato pode variar. example: id: i91011ijkl token: abc123xyz status: connected paircode: 1234-5678 qrcode: data:image/png;base64,iVBORw0KGg... name: Instância Principal profileName: Loja ABC profilePicUrl: https://example.com/profile.jpg isBusiness: true plataform: Android systemName: WppFy owner: user@example.com lastDisconnect: '2025-01-24T14:00:00Z' lastDisconnectReason: Network error adminField01: custom_data openai_apikey: sk-...xyz chatbot_enabled: true chatbot_ignoreGroups: true chatbot_stopConversation: parar chatbot_stopMinutes: 60 created: '2025-01-24T14:00:00Z' updated: '2025-01-24T14:30:00Z' currentPresence: available securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.