> ## 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. # Solicitar localização do usuário > 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. ## Campos Comuns Este endpoint suporta todos os **campos opcionais comuns** documentados na tag **"Enviar Mensagem"**, incluindo: `delay`, `readchat`, `readmessages`, `replyid`, `mentions`, `forward`, `track_source`, `track_id`, placeholders e envio para grupos. ## Estrutura do Payload ```json { "number": "5511999999999", "text": "Por favor, compartilhe sua localização", "delay": 0, "readchat": true } ``` ## Exemplo de Uso ```json { "number": "5511999999999", "text": "Para continuar o atendimento, clique no botão abaixo e compartilhe sua localização" } ``` > **Nota**: O botão de localização é adicionado automaticamente à mensagem ## OpenAPI ````yaml openapi-pt-BR.json post /send/location-button 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: /send/location-button: post: tags: - Enviar Mensagem summary: Solicitar localização do usuário description: > 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. ## Campos Comuns Este endpoint suporta todos os **campos opcionais comuns** documentados na tag **"Enviar Mensagem"**, incluindo: `delay`, `readchat`, `readmessages`, `replyid`, `mentions`, `forward`, `track_source`, `track_id`, placeholders e envio para grupos. ## Estrutura do Payload ```json { "number": "5511999999999", "text": "Por favor, compartilhe sua localização", "delay": 0, "readchat": true } ``` ## Exemplo de Uso ```json { "number": "5511999999999", "text": "Para continuar o atendimento, clique no botão abaixo e compartilhe sua localização" } ``` > **Nota**: O botão de localização é adicionado automaticamente à mensagem requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: Número do destinatário (formato internacional) example: '5511999999999' text: type: string description: Texto da mensagem que será exibida example: Por favor, compartilhe sua localização delay: type: integer description: Atraso em milissegundos antes do envio example: 0 readchat: type: boolean description: Se deve marcar a conversa como lida após envio example: true track_source: type: string description: Origem do rastreamento da mensagem example: chatwoot track_id: type: string description: ID para rastreamento da mensagem (aceita valores duplicados) example: msg_123456789 required: - number - text responses: '200': description: Localização enviada com sucesso content: application/json: schema: allOf: - $ref: '#/components/schemas/Message' - type: object properties: response: type: object properties: status: type: string example: success message: type: string example: Location sent successfully '400': description: Requisição inválida content: application/json: schema: type: object properties: error: type: string example: Missing required fields or invalid coordinates '401': description: Não autorizado content: application/json: schema: type: object properties: error: type: string example: Invalid token '500': description: Erro interno do servidor content: application/json: schema: type: object properties: error: type: string example: Failed to send location 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 fromMe: type: boolean description: Indica se a mensagem foi enviada pelo usuário default: false isGroup: type: boolean description: Indica se é uma mensagem de grupo default: false messageType: type: string enum: - text - image - video - document - audio - location - button - list - reaction description: Tipo de conteúdo da mensagem messageTimestamp: type: integer description: Timestamp original da mensagem em milissegundos default: 0 edited: type: string description: Histórico de edições da mensagem default: '' quoted: type: string description: ID da mensagem citada/respondida default: '' reaction: type: string description: ID da mensagem reagida default: '' sender: type: string description: ID do remetente da mensagem default: '' senderName: type: string description: Nome exibido do remetente default: '' source: type: string enum: - ios - web - android description: Plataforma de origem da mensagem default: '' status: type: string enum: - pending - sent - delivered - read - failed - deleted description: Status do ciclo de vida da mensagem default: '' text: type: string description: Texto original da mensagem default: '' vote: type: string description: Dados de votação de enquete e listas default: '' buttonOrListid: type: string description: ID do botão ou item de lista selecionado default: '' convertOptions: type: string description: Conversão de opções de da mensagem, lista, enquete e botões default: '' fileURL: type: string format: uri description: URL para download de arquivos de mídia default: '' content: type: string description: Conteúdo completo da mensagem em formato JSON owner: type: string description: Dono da mensagem default: '' track_source: type: string description: Origem do rastreamento da mensagem default: '' track_id: type: string description: ID para rastreamento da mensagem (aceita valores duplicados) default: '' created: type: string format: date-time description: Data de criação no sistema (formato SQLite YYYY-MM-DD HH:MM:SS.FFF) default: (strftime('%Y-%m-%d %H:%M:%f', 'now')) updated: type: string format: date-time description: Data da última atualização (formato SQLite YYYY-MM-DD HH:MM:SS.FFF) default: (strftime('%Y-%m-%d %H:%M:%f', 'now')) ai_metadata: type: object description: Metadados do processamento por IA properties: agent_id: type: string description: ID do agente de IA responsável 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 securitySchemes: token: name: token type: apiKey in: header ````