> ## 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. # Obter Detalhes Completos > Retorna informações **completas** sobre um contato ou chat, incluindo **todos os campos disponíveis** do modelo Chat. ### Funcionalidades: - **Retorna chat completo**: Todos os campos do modelo Chat (mais de 60 campos) - **Busca informações para contatos individuais e grupos** - **URLs de imagem em dois tamanhos**: preview (menor) ou full (original) - **Combina informações de diferentes fontes**: WhatsApp, contatos salvos, leads - **Atualiza automaticamente dados desatualizados** no banco ### Campos Retornados: - **Informações básicas**: id, wa_fastid, wa_chatid, owner, name, phone - **Dados do WhatsApp**: wa_name, wa_contactName, wa_archived, wa_isBlocked, etc. - **Dados de lead/CRM**: lead_name, lead_email, lead_status, lead_field01-20, etc. - **Informações de grupo**: wa_isGroup, wa_isGroup_admin, wa_isGroup_announce, etc. - **Chatbot**: chatbot_summary, chatbot_lastTrigger_id, chatbot_disableUntil, etc. - **Configurações**: wa_muteEndTime, wa_isPinned, wa_unreadCount, etc. **Comportamento**: - Para contatos individuais: - Busca nome verificado do WhatsApp - Verifica nome salvo nos contatos - Formata número internacional - Calcula grupos em comum - Para grupos: - Busca nome do grupo - Verifica status de comunidade ## OpenAPI ````yaml openapi-pt-BR.json post /chat/details 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 - Endpoints administrativos requerem um header 'admintoken' ## 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 ## Limites de Uso - O servidor possui um limite máximo de instâncias conectadas - Quando o limite é atingido, novas tentativas receberão erro 429 - Servidores gratuitos/demo podem ter restrições adicionais de tempo de vida servers: - url: https://api.wppfy.com security: - token: [] tags: - name: Admininstração description: | Endpoints para **administração geral** do sistema. Requerem um `admintoken` para autenticação. - name: Instancia description: | Operações relacionadas ao ciclo de vida de uma instância, como conectar, desconectar e verificar o status. - name: Perfil description: | Operações relacionadas ao perfil da instância do WhatsApp, como alterar nome e imagem de perfil. - name: Chamadas description: | Operações relacionadas a chamadas peloWhatsApp. Permite realizar e rejeitar chamadas programaticamente. - name: Webhooks e SSE - 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: Ações na mensagem e Buscar - name: Chats - name: Contatos - name: Bloqueios - name: Etiquetas - name: Grupos e Comunidades - 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: Mensagem em massa - name: Chatbot Configurações - name: Chatbot Trigger - name: Configuração do Agente de IA - name: Conhecimento dos Agentes - name: Funções API dos Agentes - 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 paths: /chat/details: post: tags: - Contatos summary: Obter Detalhes Completos description: > Retorna informações **completas** sobre um contato ou chat, incluindo **todos os campos disponíveis** do modelo Chat. ### Funcionalidades: - **Retorna chat completo**: Todos os campos do modelo Chat (mais de 60 campos) - **Busca informações para contatos individuais e grupos** - **URLs de imagem em dois tamanhos**: preview (menor) ou full (original) - **Combina informações de diferentes fontes**: WhatsApp, contatos salvos, leads - **Atualiza automaticamente dados desatualizados** no banco ### Campos Retornados: - **Informações básicas**: id, wa_fastid, wa_chatid, owner, name, phone - **Dados do WhatsApp**: wa_name, wa_contactName, wa_archived, wa_isBlocked, etc. - **Dados de lead/CRM**: lead_name, lead_email, lead_status, lead_field01-20, etc. - **Informações de grupo**: wa_isGroup, wa_isGroup_admin, wa_isGroup_announce, etc. - **Chatbot**: chatbot_summary, chatbot_lastTrigger_id, chatbot_disableUntil, etc. - **Configurações**: wa_muteEndTime, wa_isPinned, wa_unreadCount, etc. **Comportamento**: - Para contatos individuais: - Busca nome verificado do WhatsApp - Verifica nome salvo nos contatos - Formata número internacional - Calcula grupos em comum - Para grupos: - Busca nome do grupo - Verifica status de comunidade requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: Número do telefone ou ID do grupo example: '5511999999999' preview: type: boolean description: > Controla o tamanho da imagem de perfil retornada: - `true`: Retorna imagem em tamanho preview (menor, otimizada para listagens) - `false` (padrão): Retorna imagem em tamanho full (resolução original, maior qualidade) default: false required: - number responses: '200': description: Informações completas do chat retornadas com sucesso content: application/json: schema: allOf: - $ref: '#/components/schemas/Chat' - type: object properties: wa_common_groups: type: string description: >- Grupos em comum separados por vírgula, formato: nome_grupo(id_grupo) example: >- Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us) imagePreview: type: string description: >- URL da imagem de perfil em tamanho preview (menor) - apenas se preview=true image: type: string description: >- URL da imagem de perfil em tamanho full (resolução original) - apenas se preview=false examples: contact_example: summary: Contato individual description: Exemplo de resposta para um contato individual value: id: r1a2b3c4d5e6f7 wa_fastid: admin:5511999999999 wa_chatid: 5511999999999@s.whatsapp.net wa_name: João Silva name: João Silva phone: +55 11 99999-9999 owner: admin wa_archived: false wa_isBlocked: false wa_isGroup: false lead_name: João lead_fullName: João Silva lead_email: joao@exemplo.com lead_status: ativo wa_contactName: João Silva wa_common_groups: >- Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us) image: https://pps.whatsapp.net/v/t61.24694-24/12345_image.jpg group_example: summary: Grupo description: Exemplo de resposta para um grupo value: id: r9z8y7x6w5v4u3 wa_fastid: admin:120363123456789012@g.us wa_chatid: 120363123456789012@g.us wa_name: Grupo Família name: Grupo Família phone: '' owner: admin wa_archived: false wa_isBlocked: false wa_isGroup: true wa_isGroup_admin: true wa_isGroup_announce: false wa_isGroup_community: false wa_isGroup_member: true image: https://pps.whatsapp.net/v/t61.24694-24/67890_group.jpg '400': description: Payload inválido ou número inválido content: application/json: schema: type: object properties: error: type: string example: Invalid request payload '401': description: Token não fornecido content: application/json: schema: type: object properties: error: type: string example: Unauthorized '500': description: Erro interno do servidor ou sessão não iniciada content: application/json: schema: type: object properties: error: type: string example: No session components: schemas: Chat: type: object description: Representa uma conversa/chamado no sistema properties: id: type: string description: ID único da conversa (r + 7 bytes aleatórios em hex) wa_fastid: type: string description: Identificador rápido do WhatsApp wa_chatid: type: string description: ID completo do chat no WhatsApp wa_archived: type: boolean description: Indica se o chat está arquivado default: false wa_contactName: type: string description: Nome do contato no WhatsApp default: '' wa_name: type: string description: Nome do WhatsApp default: '' name: type: string description: Nome exibido do chat default: '' image: type: string description: URL da imagem do chat default: '' imagePreview: type: string description: URL da miniatura da imagem default: '' wa_ephemeralExpiration: type: integer format: int64 description: Tempo de expiração de mensagens efêmeras default: 0 wa_isBlocked: type: boolean description: Indica se o contato está bloqueado default: false wa_isGroup: type: boolean description: Indica se é um grupo default: false wa_isGroup_admin: type: boolean description: Indica se o usuário é admin do grupo default: false wa_isGroup_announce: type: boolean description: Indica se é um grupo somente anúncios default: false wa_isGroup_community: type: boolean description: Indica se é uma comunidade default: false wa_isGroup_member: type: boolean description: Indica se é membro do grupo default: false wa_isPinned: type: boolean description: Indica se o chat está fixado default: false wa_label: type: string description: Labels do chat em JSON default: '[]' wa_lastMessageTextVote: type: string description: Texto/voto da última mensagem default: '' wa_lastMessageType: type: string description: Tipo da última mensagem default: '' wa_lastMsgTimestamp: type: integer format: int64 description: Timestamp da última mensagem default: 0 wa_lastMessageSender: type: string description: Remetente da última mensagem default: '' wa_muteEndTime: type: integer format: int64 description: Timestamp do fim do silenciamento default: 0 owner: type: string description: Dono da instância default: '' wa_unreadCount: type: integer format: int64 description: Contador de mensagens não lidas default: 0 phone: type: string description: Número de telefone default: '' wa_common_groups: type: string description: 'Grupos em comum separados por vírgula, formato: (nome_grupo)id_grupo' default: '' example: >- Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us) lead_name: type: string description: Nome do lead default: '' lead_fullName: type: string description: Nome completo do lead default: '' lead_email: type: string description: Email do lead default: '' lead_personalid: type: string description: Documento de identificação default: '' lead_status: type: string description: Status do lead default: '' lead_tags: type: string description: Tags do lead em JSON lead_notes: type: string description: Anotações sobre o lead default: '' lead_isTicketOpen: type: boolean description: Indica se tem ticket aberto default: false lead_assignedAttendant_id: type: string description: ID do atendente responsável default: '' lead_kanbanOrder: type: integer format: int64 description: Ordem no kanban default: 0 lead_field01: type: string default: '' lead_field02: type: string default: '' lead_field03: type: string default: '' lead_field04: type: string default: '' lead_field05: type: string default: '' lead_field06: type: string default: '' lead_field07: type: string default: '' lead_field08: type: string default: '' lead_field09: type: string default: '' lead_field10: type: string default: '' lead_field11: type: string default: '' lead_field12: type: string default: '' lead_field13: type: string default: '' lead_field14: type: string default: '' lead_field15: type: string default: '' lead_field16: type: string default: '' lead_field17: type: string default: '' lead_field18: type: string default: '' lead_field19: type: string default: '' lead_field20: type: string default: '' chatbot_agentResetMemoryAt: type: integer format: int64 description: Timestamp do último reset de memória default: 0 chatbot_lastTrigger_id: type: string description: ID do último gatilho executado default: '' chatbot_lastTriggerAt: type: integer format: int64 description: Timestamp do último gatilho default: 0 chatbot_disableUntil: type: integer format: int64 description: Timestamp até quando chatbot está desativado default: 0 created: type: string description: Data de criação default: strftime('%Y-%m-%d %H:%M:%f', 'now') updated: type: string description: Data da última atualização default: strftime('%Y-%m-%d %H:%M:%f', 'now') securitySchemes: token: name: token type: apiKey in: header ````