> ## 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. # Editar respuesta rápida > Cambia solo los campos enviados. `message` sustituye el mensaje completo; cambiar o quitar un archivo elimina el anterior. Si otra edición cambia el mensaje al mismo tiempo, esta devuelve `409` con `conflict` y no se guarda nada. Las respuestas en WhatsApp Business siguen siendo solo de texto. ## OpenAPI ````yaml /openapi-es.json patch /quick-replies/{id} openapi: 3.1.0 info: title: WppFy - WhatsApp API version: 1.0.0 description: > API para la gestión de instancias de WhatsApp y comunicaciones. ## Recomendación Importante: WhatsApp Business **Se RECOMIENDA ENCARECIDAMENTE usar cuentas de WhatsApp Business** en lugar de WhatsApp normal para la integración; WhatsApp normal puede presentar inconsistencias, desconexiones, limitaciones e inestabilidad durante el uso con nuestra API. ## Autenticación - Los endpoints regulares requieren un header 'token' con el token de la instancia ## Estados de la Instancia Las instancias pueden estar en los siguientes estados: - `disconnected`: Desconectado de WhatsApp - `connecting`: En proceso de conexión - `connected`: Conectado y autenticado con éxito servers: - url: https://api.wppfy.com security: - token: [] tags: - name: Instancia description: > Operaciones relacionadas con el ciclo de vida de una instancia, como conectar, desconectar y verificar el estado. - name: Proxy description: > WppFy opera con un proxy interno por defecto. Puede mantener este valor predeterminado, configurar un proxy propio mediante `proxy_url` o usar su celular Android como proxy instalando la app en https://github.com/WppFy/silver_proxy_apk (APK directo: https://github.com/WppFy/silver_proxy_apk/raw/refs/heads/main/silver_proxy.apk). Si no se envía nada, se sigue usando el proxy interno. Las IPs son brasileñas; para clientes internacionales, considere un proxy de la región del cliente. - name: Perfil description: > Operaciones relacionadas con el perfil de la instancia de WhatsApp, como cambiar el nombre y la imagen de perfil. - name: Business description: > ⚠️ **EXPERIMENTAL** - Endpoints aún no probados por completo. Operaciones relacionadas con el perfil comercial de WhatsApp Business. Permite consultar y actualizar datos del perfil comercial como descripción, dirección, email, categorías y gestionar el catálogo de productos. **Requisitos:** - La cuenta conectada actualmente debe ser una cuenta **WhatsApp Business** - Las cuentas personales de WhatsApp no tienen perfil comercial **Nota:** Estos endpoints pueden no funcionar como se espera. Reporte los problemas encontrados. - name: Llamadas description: | Operaciones relacionadas con llamadas por WhatsApp. Permite realizar y rechazar llamadas de forma programática. - name: Enviar Mensaje description: > Endpoints para el envío de mensajes de WhatsApp con diferentes tipos de contenido. ## Campos Opcionales Comunes Todos los endpoints de envío de mensajes soportan los siguientes campos opcionales: - **`delay`** *(integer)*: Retraso en milisegundos antes del envío - Durante el retraso aparecerá "Escribiendo..." o "Grabando audio..." según el tipo - Ejemplo: `5000` (5 segundos) - **`readchat`** *(boolean)*: Marcar el chat como leído después del envío - Quita el contador de mensajes no leídos del chat - Ejemplo: `true` - **`readmessages`** *(boolean)*: Marcar los últimos mensajes recibidos como leídos - Marca los últimos 10 mensajes **recibidos** (no enviados por usted) como leídos - Útil para confirmar la lectura de mensajes pendientes antes de responder - A diferencia de `readchat`, que solo quita el contador de no leídos - Ejemplo: `true` - **`replyid`** *(string)*: ID del mensaje a responder - Crea una respuesta vinculada al mensaje original - El soporte varía según el tipo de mensaje - Ejemplo: `"3A12345678901234567890123456789012"` - **`mentions`** *(string)*: Números a mencionar (solo para envíos en grupos) - Números específicos: `"5511999999999,5511888888888"` - Mencionar a todos: `"all"` - **`forward`** *(boolean)*: Marca el mensaje como reenviado en WhatsApp - Agrega el indicador "Reenviado" al mensaje - Ejemplo: `true` - **`track_source`** *(string)*: Origen del rastreo del mensaje - Identifica el sistema o la fuente que está enviando el mensaje - Útil para integraciones (ej.: "chatwoot", "crm", "chatbot") - Ejemplo: `"chatwoot"` - **`track_id`** *(string)*: ID para el rastreo del mensaje - Identificador libre para dar seguimiento al mensaje en sistemas externos - Permite correlacionar mensajes entre diferentes plataformas - **Nota**: El sistema acepta valores duplicados; no hay validación de unicidad - Use el mismo ID en varios mensajes si tiene sentido para su integración - Ejemplo: `"msg_123456789"` ### Envío a Grupos - **`number`** *(string)*: Para enviar un mensaje a un grupo, use el ID del grupo que termina en `@g.us` - Ejemplo: `"120363012345678901@g.us"` - **Cómo obtener el ID del grupo:** - Use el `chatid` del webhook recibido cuando alguien envía un mensaje en el grupo - Use el endpoint `GET /group/list` para listar todos los grupos y sus IDs ## Placeholders Disponibles Todos los endpoints de envío de mensajes soportan placeholders dinámicos para personalización automática: ### Campos de Nombre - **`{{name}}`**: Nombre consolidado del chat, usando la primera opción disponible: 1. Nombre del lead (`lead_name`) 2. Nombre completo del lead (`lead_fullName`) 3. Nombre del contacto en WhatsApp (`wa_contactName`) 4. Nombre del perfil de WhatsApp (`wa_name`) - **`{{first_name}}`**: Primera palabra válida del nombre consolidado (mínimo 2 caracteres) ### Campos de WhatsApp - **`{{wa_name}}`**: Nombre del perfil de WhatsApp - **`{{wa_contactName}}`**: Nombre del contacto tal como está guardado en WhatsApp ### Campos del Lead - **`{{lead_name}}`**: Nombre del lead - **`{{lead_fullName}}`**: Nombre completo del lead - **`{{lead_personalid}}`**: ID personal (CPF, CNPJ, etc) - **`{{lead_email}}`**: Email del lead - **`{{lead_status}}`**: Estado actual del lead - **`{{lead_notes}}`**: Anotaciones del lead - **`{{lead_assignedAttendant_id}}`**: ID del agente asignado ### Campos Personalizados Los campos agregados mediante custom fields son accesibles usando `{{lead_field01}}` a `{{lead_field20}}` o usando `{{nomedocampo}}` definido en `/instance/updateFieldsMap`. ### Ejemplo de Uso ``` ¡Hola {{name}}! Vi que usted trabaja en {{company}}. ¿Su email {{lead_email}} es correcto? ``` **💡 Consejo**: Use `/chat/find` para buscar los datos del chat y ver los campos disponibles antes de enviar mensajes con placeholders. - name: Mensaje Async description: > Controles operativos de la cola interna de envío asíncrono usada cuando un endpoint de envío recibe `async=true`. Esta sección sirve para: - consultar el estado actual de la cola async - configurar el delay entre mensajes enviados con `async=true` - limpiar el backlog pendiente y cancelar mensajes aún no concluidos Alcance: - cubre solo la cola interna de mensajes directos async - no modifica mensajes ya enviados correctamente - name: Acciones en el mensaje y Búsqueda - name: Chats - name: Contactos - name: Bloqueos - name: Etiquetas - name: Grupos y Comunidades - name: Newsletters y Canales description: > Operaciones para la lectura y el seguimiento de canales de WhatsApp (newsletters). Casos de uso principales: - listar posts ya publicados en un canal - editar posts recientes de un canal - eliminar posts recientes de un canal - consultar views y reacciones de los posts - integrar canales sin necesidad de persistir los mensajes localmente Observaciones: - `/newsletter/messages` devuelve el contenido de los posts - `/newsletter/messages/edit` edita el contenido de posts recientes - `/newsletter/messages/delete` elimina posts recientes - las views (`viewsCount`) y reactions (`reactionCounts`) vienen en cada post de `/newsletter/messages`, no por evento de webhook - `/newsletter/updates` está obsoleta: WhatsApp no responde y la API devuelve 504 - los newsletters usan rutas propias y no deben usar `/message/edit` ni `/message/delete` - name: Respuestas Rápidas description: > Gestión de respuestas rápidas para agilizar la atención. **⚠️ Importante**: Este recurso solo es útil si utiliza un sistema frontend/interfaz personalizada para registrar y utilizar las respuestas. La API solo almacena las respuestas, pero no las aplica automáticamente. ### Cómo funciona: - **Crear**: Registre respuestas predefinidas con títulos y contenido - **Listar**: Recupere todas las respuestas registradas para mostrarlas en su interfaz - **Usar**: Su sistema frontend puede usar estas respuestas para agilizar la escritura ### Casos de uso: - Interfaces web personalizadas de atención - Apps móviles con sugerencias de respuesta - Sistemas CRM con plantillas de mensaje - Herramientas de productividad para agentes **No es un chatbot**: Para respuestas automáticas, use los recursos de Chatbot. - name: CRM description: > Sistema completo de gestión de relaciones con clientes integrado a la API. **💾 Almacenamiento interno**: Todos los datos de los leads se guardan directamente en la API, eliminando la necesidad de bases de datos externas. Su aplicación puede enfocarse solo en la interfaz y la lógica de negocio. ### Recursos disponibles: - **📋 20+ campos personalizables**: Nombre, teléfono, email, empresa, observaciones, etc. - **🏷️ Sistema de etiquetas**: Organice y categorice sus contactos - **🔍 Búsqueda avanzada**: Filtre por cualquier campo o etiqueta - **📊 Historial completo**: Todas las interacciones se registran automáticamente ### 🎯 Placeholders en mensajes: Use variables dinámicas en los mensajes para la personalización automática: ``` ¡Hola {{nombre}}! Vi que trabaja en {{empresa}}. ¿Su email {{email}} es correcto? Observaciones: {{observaciones}} ``` ### Flujo típico: 1. **Captura**: Los leads llegan vía WhatsApp o formularios 2. **Enriquecimiento**: Agregue datos usando `/chat/editLead` 3. **Segmentación**: Organice con etiquetas 4. **Comunicación**: Envíe mensajes personalizados con placeholders 5. **Seguimiento**: El historial se guarda automáticamente **Ideal para**: Ventas, marketing, atención, calificación de leads - name: Integración con Chatwoot description: > **🚧 INTEGRACIÓN BETA - Sistema de integración con Chatwoot para atención unificada** **⚠️ AVISO**: Esta integración está en fase BETA. Úsela bajo su propio riesgo. Recomendamos realizar pruebas en un entorno no productivo antes de usarla en producción. Esta categoría contiene recursos para configurar y gestionar la integración con Chatwoot, una plataforma de atención al cliente open-source. La integración permite centralizar las conversaciones de WhatsApp en Chatwoot. ### Recursos disponibles: - 🔧 **Configuración Completa**: Configure URL, tokens y credenciales de Chatwoot - 📬 **Sincronización Bidireccional**: Los mensajes nuevos entre WhatsApp y Chatwoot se sincronizan automáticamente - 📱 **Gestión de Contactos**: Sincronización automática de nombres y teléfonos - 🔄 **Actualización LID→PN**: Migración automática de Local ID a Phone Number - 🏷️ **Nombres Inteligentes**: Sistema de nombres con tilde (~) para actualización automática - 🚫 **Separación de Grupos**: Opción para ignorar grupos en la sincronización - 👤 **Firma de Mensajes**: Identificación del agente en los mensajes enviados - 🔗 **Webhook Automático**: URL generada automáticamente para configurar en Chatwoot ### 🏷️ Sistema de Nombres Inteligentes: - **Nombres con tilde (~)**: Se actualizan automáticamente cuando el contacto modifica su nombre en WhatsApp - **Nombres específicos**: Para un nombre fijo, quite la tilde (~) del nombre en Chatwoot - **Ejemplo**: "~Juan Pérez" = automático, "Juan Pérez" = fijo - **Migración LID→PN**: Sin duplicación de conversaciones durante la transición - **Respuestas nativas**: Aparecen directamente en Chatwoot sin marcas externas ### ⚠️ Limitaciones conocidas: - **Sincronización del historial**: No implementada - solo se sincronizan los mensajes nuevos ### Casos de uso: - Atención centralizada en Chatwoot - Equipos de soporte con múltiples agentes - Integración con CRM mediante Chatwoot - Centralización de canales de comunicación - Gestión automática de contactos y nombres **Ideal para**: Empresas con equipos de atención, call centers, soporte técnico (en entorno de pruebas) **Requiere**: Instancia de Chatwoot configurada, tokens de API y entorno de pruebas **🚧 Recuerde**: Integración en BETA - las funcionalidades pueden cambiar sin previo aviso - name: Server-Sent Events (SSE) paths: /quick-replies/{id}: patch: tags: - Respuestas Rápidas summary: Editar respuesta rápida description: >- Cambia solo los campos enviados. `message` sustituye el mensaje completo; cambiar o quitar un archivo elimina el anterior. Si otra edición cambia el mensaje al mismo tiempo, esta devuelve `409` con `conflict` y no se guarda nada. Las respuestas en WhatsApp Business siguen siendo solo de texto. parameters: - name: id in: path required: true schema: type: string description: ID de la respuesta rápida. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QuickReplyItemInput' example: shortCut: endereco-centro responses: '200': description: Respuesta rápida actualizada content: application/json: schema: $ref: '#/components/schemas/QuickReplyItem' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/QuickReplyConflict' '500': $ref: '#/components/responses/InternalError' '502': $ref: '#/components/responses/WhatsAppSyncFailed' components: schemas: QuickReplyItemInput: type: object additionalProperties: false description: >- En la creación, `shortCut` y `message` son obligatorios. En la edición, solo cambian los campos enviados; `message` reemplaza el mensaje completo. properties: shortCut: type: string description: Atajo para encontrar la respuesta (y lo que la IA usa para elegir). aiDescription: type: string description: Reservado para la atención automática. Vacío por defecto. onWhatsApp: type: boolean description: >- Solo en la creación y solo con `kind: text`: también lo crea en WhatsApp Business. message: $ref: '#/components/schemas/QuickReplyMessage' QuickReplyItem: type: object required: - id - shortCut - aiDescription - onWhatsApp - message - createdAt - updatedAt properties: id: type: string readOnly: true shortCut: type: string description: Atajo para encontrar la respuesta (y lo que la IA usa para elegir). aiDescription: type: string description: Reservado para la atención automática. Vacío por defecto. onWhatsApp: type: boolean description: Si la respuesta también está en WhatsApp Business (solo texto). message: $ref: '#/components/schemas/QuickReplyMessage' createdAt: type: string readOnly: true updatedAt: type: string readOnly: true QuickReplyMessage: type: object required: - kind additionalProperties: true description: >- Mensaje guardado: `kind` más el mismo cuerpo del envío correspondiente, sin `number` y sin campos de envío (`replyid`, `mentions`, `delay`, `readchat`, `readmessages`, `async`, `forward`, `track_source`, `track_id`). | kind | Cuerpo igual a | Observación | |---|---|---| | `text` | `text` | Acepta placeholders como `{{name}}`. | | `media` | [`/send/media`](/endpoint/post/send~media): `type`, `file`, `text`, `docName` | `type`: image, video, document, audio, ptt o myaudio. Un `file` por URL se conserva tal como se envió; en base64, la API lo guarda (imagen 5 MB, audio y video 16 MB, documento 20 MB; 50 MB por instancia). | | `contact` | [`/send/contact`](/endpoint/post/send~contact) | `fullName` y `phoneNumber` obligatorios. | | `location` | [`/send/location`](/endpoint/post/send~location) | `latitude` y `longitude` obligatorias. | | `menu` | [`/send/menu`](/endpoint/post/send~menu) | `type`: button, button_legacy, list o poll (carrusel todavía no). El medio del botón (`file`) solo por URL. Las opciones deben poder enviarse, de lo contrario `400`: encuesta con al menos 2, lista con al menos un elemento (la sección `[...]` no cuenta) y botones con al menos 1. | | `pix` | [`/send/pix-button`](/endpoint/post/send~pix-button) | `pixType` y `pixKey` obligatorios. | properties: kind: type: string enum: - text - media - contact - location - menu - pix example: kind: location name: Loja Centro address: Av. Paulista, 1000 latitude: -23.5614 longitude: -46.6559 ApiError: type: object description: >- Error estándar de las rutas nuevas. `code` es estable y sirve para tratar el error en el código; `error` es el mensaje para personas y puede cambiar. required: - error properties: error: type: string description: Mensaje legible del error. example: temperature must be between 0 and 2 code: type: string description: Código estable del error, como `validation_failed` o `not_found`. example: validation_failed AuthError: type: object description: >- Error de autenticación, el mismo en todas las rutas: `code` es el estado HTTP. required: - code - message properties: code: type: integer example: 401 message: type: string example: Token inválido. data: type: object responses: BadRequest: description: >- Solicitud inválida. `invalid_body`: JSON mal formado o campo desconocido. `validation_failed`: valor fuera de lo permitido. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Token ausente o inválido. content: application/json: schema: $ref: '#/components/schemas/AuthError' NotFound: description: Ningún recurso con ese `id` en esta instancia. content: application/json: schema: $ref: '#/components/schemas/ApiError' QuickReplyConflict: description: >- Conflicto con el estado de la instancia o de la respuesta. `instance_not_paired`: la instancia aún no se ha conectado a WhatsApp; conéctela primero. `instance_not_connected`: la respuesta de WhatsApp Business (`onWhatsApp`) solo se crea, edita o elimina con la instancia conectada. `conflict` (solo en la edición): otra edición cambió el mensaje al mismo tiempo; no se guardó nada, lea la respuesta de nuevo y repita. content: application/json: schema: $ref: '#/components/schemas/ApiError' InternalError: description: Error inesperado al escribir o leer los datos. content: application/json: schema: $ref: '#/components/schemas/ApiError' WhatsAppSyncFailed: description: >- El cambio no llegó a WhatsApp Business (`whatsapp_sync_failed`). Solo ocurre con respuestas `onWhatsApp`. No se guardó ni se eliminó nada; intente de nuevo. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.