> ## 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. # Estado del mensaje en grupo > Muestra quién recibió y quién leyó un mensaje enviado por usted en un grupo: primero un resumen con los totales, luego la lista de cada participante. `source` indica de dónde provino la respuesta. - `source: "memory"`: después de que esta ruta se usa para un grupo, la API comienza a seguir en memoria las confirmaciones de los grupos de la instancia, hasta 24 horas después de la última consulta. A partir de ahí se responden, al instante y sin depender del teléfono, los mensajes enviados desde entonces y los que el teléfono ya respondió, sumando las confirmaciones que llegaron después. Cada mensaje permanece hasta 24 horas en memoria; en instancias con mucho envío a grupos, los más antiguos salen antes. - `source: "phone"`: la primera consulta de un mensaje enviado antes de eso, o de cualquier mensaje después de un reinicio del servidor, se hace al teléfono de la cuenta. El teléfono debe estar encendido y con internet. Con WhatsApp abierto, la respuesta llega en aproximadamente 1 segundo; con el teléfono inactivo (un iPhone en segundo plano, por ejemplo), puede no llegar. Sin respuesta en 40 segundos, la ruta devuelve `504`. La lista es la que guarda el teléfono: justo después de quedarse sin internet, puede responder antes de recibir las confirmaciones que llegaron en ese intervalo. - `summary`: cuántos participantes recibieron (`delivered`) y leyeron (`read`). Quien leyó también cuenta como recibido, y quien escuchó un audio o vio un video cuenta como leído. - `receipts`: un elemento por participante y estado, en orden cronológico y por páginas, como en las demás listas de la API: para la siguiente, envíe `pagination.nextOffset` en `offset` mientras `pagination.hasMore` sea `true`. El resumen viene en todas. - Quien leyó puede venir sin el elemento `Delivered`, cuando el teléfono no guardó la hora de entrega. - `state` filtra la lista por estado: `Delivered`, `Read` o `Played`. El resumen mantiene los totales del mensaje. - `id` acepta el ID completo o el corto del mensaje, que debe estar en el historial de la instancia. - La API no guarda las confirmaciones en una base de datos. Para seguirlas en tiempo real, use el webhook `messages_update` con `type: "GroupReceipts"`. ## OpenAPI ````yaml /openapi-es.json post /message/status 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: /message/status: post: tags: - Acciones en el mensaje y Búsqueda summary: Estado del mensaje en grupo description: > Muestra quién recibió y quién leyó un mensaje enviado por usted en un grupo: primero un resumen con los totales, luego la lista de cada participante. `source` indica de dónde provino la respuesta. - `source: "memory"`: después de que esta ruta se usa para un grupo, la API comienza a seguir en memoria las confirmaciones de los grupos de la instancia, hasta 24 horas después de la última consulta. A partir de ahí se responden, al instante y sin depender del teléfono, los mensajes enviados desde entonces y los que el teléfono ya respondió, sumando las confirmaciones que llegaron después. Cada mensaje permanece hasta 24 horas en memoria; en instancias con mucho envío a grupos, los más antiguos salen antes. - `source: "phone"`: la primera consulta de un mensaje enviado antes de eso, o de cualquier mensaje después de un reinicio del servidor, se hace al teléfono de la cuenta. El teléfono debe estar encendido y con internet. Con WhatsApp abierto, la respuesta llega en aproximadamente 1 segundo; con el teléfono inactivo (un iPhone en segundo plano, por ejemplo), puede no llegar. Sin respuesta en 40 segundos, la ruta devuelve `504`. La lista es la que guarda el teléfono: justo después de quedarse sin internet, puede responder antes de recibir las confirmaciones que llegaron en ese intervalo. - `summary`: cuántos participantes recibieron (`delivered`) y leyeron (`read`). Quien leyó también cuenta como recibido, y quien escuchó un audio o vio un video cuenta como leído. - `receipts`: un elemento por participante y estado, en orden cronológico y por páginas, como en las demás listas de la API: para la siguiente, envíe `pagination.nextOffset` en `offset` mientras `pagination.hasMore` sea `true`. El resumen viene en todas. - Quien leyó puede venir sin el elemento `Delivered`, cuando el teléfono no guardó la hora de entrega. - `state` filtra la lista por estado: `Delivered`, `Read` o `Played`. El resumen mantiene los totales del mensaje. - `id` acepta el ID completo o el corto del mensaje, que debe estar en el historial de la instancia. - La API no guarda las confirmaciones en una base de datos. Para seguirlas en tiempo real, use el webhook `messages_update` con `type: "GroupReceipts"`. requestBody: required: true content: application/json: schema: type: object required: - id properties: id: type: string description: ID del mensaje (completo o corto). example: 3EB0538DA65A59F6D8A251 state: type: string enum: - Delivered - Read - Played description: Solo las confirmaciones de este estado. Sin él, todas. limit: type: integer minimum: 1 maximum: 500 default: 100 description: Elementos por página. Valores superiores a 500 usan 500. offset: type: integer minimum: 0 default: 0 description: >- Desplazamiento con base cero; use el `pagination.nextOffset` de la página anterior. responses: '200': description: Resumen y página de confirmaciones, en orden cronológico. content: application/json: schema: type: object required: - source - summary - receipts - pagination properties: source: type: string enum: - memory - phone description: >- De dónde provino la respuesta: `memory` (confirmaciones que la API registró, sumadas a la respuesta anterior del celular cuando la hubo) o `phone` (el celular de la cuenta, en esta consulta). summary: type: object description: Totales de participantes; los mismos en todas las páginas. required: - delivered - read properties: delivered: type: integer format: int64 description: >- Participantes que recibieron, incluidos quienes leyeron o escucharon. read: type: integer format: int64 description: >- Participantes que leyeron, incluidos quienes escucharon un audio o vieron un video. receipts: type: array items: type: object required: - participant - participant_pn - participant_lid - state - timestamp properties: participant: type: string description: >- Quién confirmó: el número cuando se conoce; de lo contrario, el LID. participant_pn: type: - string - 'null' participant_lid: type: - string - 'null' state: type: string enum: - Delivered - Read - Played timestamp: type: integer format: int64 description: >- Segundos Unix de esta confirmación, tal como los guardó el celular. pagination: type: object required: - totalRecords - limit - offset - hasMore - nextOffset properties: totalRecords: type: integer format: int64 description: Total de confirmaciones del mensaje. limit: type: integer description: Límite aplicado en la página actual. offset: type: integer description: >- Offset devuelto, limitado al intervalo de cero a totalRecords. hasMore: type: boolean description: Hay más confirmaciones después de esta página. nextOffset: type: integer description: Offset de la página siguiente. '400': description: Payload inválido o `id` ausente '401': description: Token inválido o ausente '404': description: Mensaje fuera del historial de la instancia o de otro número '500': description: Error al buscar el mensaje '503': description: Instancia sin conexión, no es posible consultar al teléfono '504': description: >- El teléfono no respondió en 40 segundos; debe estar encendido y con conexión a internet components: securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.