Funnelchat APIReferencia
Todos los endpoints de la API v0, con las piezas primero, ejemplos en varios lenguajes y prueba en vivo.
Cada endpoint tiene su página: para qué sirve, el permiso que pide, sus parámetros, ejemplos en varios lenguajes y las respuestas posibles. Están ordenados por recurso, sin importar de qué dominio vienen: primero las piezas con las que armás lo tuyo (mensajes, contactos y datos, grupos, números) y después las funciones de Funnelchat (flows, campañas, difusiones, tableros, lead score, ventas, alertas), que podés consultar si ya las usás. Cada página muestra su URL completa: la URL base única + la ruta /api/v1/… (ver Cómo armar la URL).
- Conversations · 152 operaciones: 152 disponibles para claves en v0.
- Communities · 53 operaciones: 53 disponibles para claves en v0.
- Accounts · 68 operaciones: 68 disponibles para claves en v0.
Los eventos y las suscripciones de webhooks están en su propia pestaña: Webhooks.
Probar en vivo: en cualquier endpoint, el botón para probar abre un formulario. Pegá tu clave completa (<id>|fc_live_…) en Authorization y enviá: la llamada sale de tu navegador directo a la URL base de la API. La clave queda en el navegador solo mientras recorrés el portal en esa pestaña: se borra al cerrarla, al recargarla o al salir del portal. Las operaciones que no están abiertas a claves en v0 llevan una «Nota del portal».
Toda la API en una sola especificación: specs/funnelchat.json, OpenAPI 3.1. Es la principal: 237 operaciones de las tres áreas con la URL base única en servers y las rutas completas, cada una con el permiso que pide (x-fc-permission), el área que la atiende (x-fc-domain) y las notas de v0. Es la que conviene para generar un cliente o dársela a tu IA. Qué rutas no entran y por qué: Procedencia.
Por área siguen las especificaciones tal como las publicó cada dominio (specs/<dominio>.json) o con las notas de v0 (specs/<dominio>.anotada.json). Ver Procedencia para el SHA y la hora de cada una.
Piezas
Mensajes
Conversaciones
11 endpoints · Una conversación es el chat de WhatsApp entre tu negocio y un contacto: puede estar activa o no (active_conversation), asignada a un asesor, marcada como favorita o sin leer, y la atiende uno de tus números.
Mensajes
1 endpoint · Contiene el envío de un mensaje de texto o archivo indicando en el cuerpo el contact_id y el número desde el que sale (device_id).
Plantillas
7 endpoints · Una plantilla es un mensaje de WhatsApp que Meta aprueba antes de usarse, con encabezado, cuerpo con variables, pie y botones, asociado a un número (device_id) y su WABA.
Reacciones
2 endpoints · Una reacción es un emoji que ponés sobre un mensaje de una conversación, por ejemplo para acusar recibo sin escribir una respuesta.
Reenvío de mensajes
1 endpoint · Permite reenviar un mensaje de una conversación a otros contactos, eligiendo en targets desde qué número (device_id) sale cada envío.
Tarjetas de contacto
1 endpoint · Una tarjeta de contacto le comparte a un contacto los datos de otra persona, por ejemplo de un vendedor o de soporte.
Formularios de WhatsApp
1 endpoint · Un formulario de WhatsApp es un formulario de varias pantallas que el contacto completa dentro del chat.
Contactos y datos
Contactos
12 endpoints · Un contacto es la persona con la que tu negocio conversa por WhatsApp, identificada por phone o whatsapp_id.
Notas de contactos
3 endpoints · Las notas son comentarios que el equipo deja en la ficha de un contacto, con texto (body), autor (author_name) y fecha.
Etiquetas
6 endpoints · Las etiquetas (name, description, color) marcan contactos para segmentarlos según los criterios de tu negocio, y cada una puede informar cuántos contactos la tienen (contact_count).
Campos personalizados
5 endpoints · Un campo personalizado es un dato propio de tu negocio que guardás en los contactos, como plan, ciudad o fecha de compra.
Grupos
Grupos
9 endpoints · Un grupo es un grupo de WhatsApp que administra uno de tus números, con o sin campaña asignada; acá también aparecen los canales y los grupos de anuncios de una comunidad.
Participantes
5 endpoints · Un participante es una persona que está o estuvo en un grupo de una campaña, identificada por teléfono (phone), con su grupo actual, fechas de entrada y salida (joined_at, left_at), estado y si es administrador.
Números
Números
18 endpoints · Un número es una línea de WhatsApp conectada a tu cuenta (en las rutas, devices), por código QR o por WhatsApp Cloud.
Salud del número
2 endpoints · La salud describe cómo ve Meta a un número de WhatsApp Cloud: health, identidad, entidades, nivel de throughput (throughput_level) e historial de cambios.
Historial de conexión
1 endpoint · Registra cada vez que un número se conectó o se desconectó (event), con el teléfono y la fecha, del evento más reciente al más antiguo.
Registros del número
2 endpoints · Los registros de actividad de un número muestran cada petición con método, URL, código HTTP, duración, si fue error y los cuerpos de pedido y respuesta, en una ventana de tiempo y paginados por cursor.
Registros globales
1 endpoint · Son los mismos registros de actividad de Registros del número, pero de todos tus números juntos: método, URL, código HTTP, duración y errores en una ventana de tiempo, del más reciente al más antiguo y paginados por cursor.
Nombre de usuario
3 endpoints · Es el nombre de usuario de WhatsApp que se reserva en Meta para uno de tus números.
Encuesta de desconexión
2 endpoints · Es la encuesta sobre el motivo por el que se desconectó un número.
Funciones de Funnelchat
Flows
Flujos
8 endpoints · Un flujo es una automatización: un disparador (trigger_type, trigger_values, trigger_device_ids) inicia una cadena de nodos (nodes) que se ejecuta para un contacto.
Carpetas de flujos
5 endpoints · Las carpetas organizan tus flujos de automatización en una jerarquía: cada una tiene name, una carpeta madre opcional (parent_id), subcarpetas (children) y la cantidad de flujos que contiene (flows_count).
Automatizaciones del contacto
2 endpoints · Reúne lo que define cómo participa un contacto de las automatizaciones de la cuenta.
Campañas de grupos
Campañas
3 endpoints · Una campaña agrupa grupos de WhatsApp de tu cuenta detrás de un link de redirección y define cómo se distribuye el tráfico entre ellos (traffic_distribution_type), con límites de clics y participantes (clicks_limit, participants_limit).
Operaciones de campaña
9 endpoints · Reúne los grupos de una campaña (los que tiene y los que se pueden sumar) y las operaciones masivas sobre ellos: cambios de nombre, foto, descripción, administradores o participantes.
Mensajes programados
6 endpoints · Un envío programado manda uno o más mensajes a grupos de WhatsApp en una fecha (send_at), una vez o con recurrencia, a campañas o grupos puntuales y con grupos excluidos.
Respuestas y carpetas
3 endpoints · Complementa a los mensajes programados.
Estadísticas
7 endpoints · Métricas de tus grupos o campañas por hora, día o mes: entradas y salidas de participantes, participantes activos e inactivos, grupos por estado y clics en links.
Difusiones
Embudo y ventas
Tableros
6 endpoints · Un tablero kanban modela un proceso, como tu embudo de ventas o de atención, y ubica a cada contacto en una de sus etapas.
Etapas de tableros
10 endpoints · Las etapas son los pasos de un tablero (name, position, contacts_count), y en cada tablero un contacto tiene una etapa actual (current_stage_id).
Configuración del lead score
3 endpoints · Define cómo se calcula el lead score de la cuenta: los umbrales de caliente y tibio (hot_threshold, warm_threshold), las señales mínimas (min_signals), la histéresis, el decaimiento de puntos con los días (decay_steps) y las reglas.
Distribución del lead score
1 endpoint · Muestra cómo se reparte tu base de contactos entre las categorías del lead score (hot, warm, cold e insufficient_data), con el total y los umbrales vigentes.
Eventos de lead score
1 endpoint · Recibe señales de interacción que alimentan el lead score (signal): entradas y salidas de grupos, reacciones y votos en grupos, y clics en links.
Lead score del contacto
1 endpoint · El lead score estima qué tan caliente está un contacto a partir de señales de interacción.
Ventas
4 endpoints · Reúne las ventas que reportan tus plataformas de pagos: cada venta trae producto, monto (amount_minor) y moneda, plataforma, tipo de evento, comprador (con su contact_id si lo hay) y atribución.
Productos de pago
1 endpoint · Lista los productos de una plataforma de pagos ({platform}) con su ID externo (external_product_id) y nombre.
Atención y equipo
Respuestas rápidas
5 endpoints · Las respuestas rápidas son mensajes guardados, de texto o con archivo, que el equipo usa para contestar lo frecuente sin escribirlo cada vez.
Tickets
7 endpoints · Un ticket es un caso abierto sobre un contacto (contact_id), con título, descripción, fecha límite (deadline) y un usuario del equipo responsable (user_id).
Agentes
2 endpoints · Los agentes son las personas del equipo que atienden en la cuenta, con name, email y su alcance como asesor (advisor_scope).
Alertas
Catálogo de alertas
1 endpoint · Las alertas operativas avisan de lo que pasa en tu cuenta: números desconectados, consumo de MACs, cobros, campañas, grupos y más.
Destinos de alertas
4 endpoints · Un destino es a dónde llegan tus alertas: un teléfono o un webhook HTTPS (type).
Verificación de teléfonos
2 endpoints · Un destino de alertas de tipo teléfono se verifica con un código.
Activación de alertas
1 endpoint · Define qué alertas recibe cada destino verificado.
Horario de silencio
2 endpoints · Es una franja horaria sin alertas, por ejemplo de noche, definida con start_time y end_time y activable con enabled.
Reporte diario
2 endpoints · El reporte diario es una alerta que se envía a la hora que elijas (send_time) y cubre todas tus campañas de grupos (all_campaigns) o solo algunas (campaign_ids).
Campañas para alertas
1 endpoint · Lista, con búsqueda por nombre, las campañas de grupos de WhatsApp de la cuenta que podés elegir al configurar alertas como el reporte diario.
Prueba de destinos webhook
1 endpoint · Envía un payload de prueba fijo a un destino de alertas de tipo webhook y te devuelve el estado, si respondió bien (ok) y la latencia.
Cuenta y consumo
Mi cuenta
1 endpoint · Es la cuenta de Funnelchat a la que pertenece tu clave de API: su plan, los límites de números y agentes, tu rol, la zona horaria y el idioma.
Dominios propios
5 endpoints · Un dominio propio es un dominio tuyo, por ejemplo para los links de tus campañas, que apunta al servicio de redirección de Funnelchat.
Conversions API
3 endpoints · Conecta el WABA de un número con un dataset de Meta Conversions API.
Contactos activos (MAC)
3 endpoints · Un MAC es un contacto activo que cuenta para el límite de contactos activos de tu plan en el ciclo.
Costos de WhatsApp
1 endpoint · Muestra cuánto gastaste en WhatsApp en un mes calendario: el actual o el que indiques con month (AAAA-MM).