Funnelchat APINúmeros
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.
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. Trae alias, number, provider, waba_id, si está conectado (connected) y su salud (health). Acá también están su cola de mensajes y las operaciones irreversibles (reiniciar, limpiar, eliminar, vaciar la cola), que piden accounts:operate. Empezá por Listar números: sus IDs los usan las demás operaciones.
Endpoints
Listar números
GET /api/v1/devices · Sirve para listar tus números de WhatsApp con su proveedor, si están conectados y activos y su estado de salud, y obtener los IDs que usan las demás operaciones.
Ver el perfil de WhatsApp de un número
GET /api/v1/devices/{device}/me · Usalo para leer el perfil de WhatsApp de uno de tus números tal como lo informa el proveedor.
Verificar si un teléfono tiene WhatsApp
GET /api/v1/devices/{device}/check-phone · Sirve para validar si un teléfono tiene WhatsApp antes de cargarlo como contacto o escribirle, y así evitar envíos fallidos.
Ver un número
GET /api/v1/devices/{device} · Usalo para ver los datos de un número: alias, proveedor, WABA, nombre de usuario, si está conectado y su estado de salud.
Eliminar un número
DELETE /api/v1/devices/{device} · Usalo para dar de baja un número de la cuenta de forma definitiva. Es irreversible y requiere el permiso accounts:operate.
Actualizar un número
PUT /api/v1/devices/{device} · Sirve para actualizar los datos de un número (alias, color, imagen) o completar sus datos de WhatsApp Business, como WABA y phone number ID, y el consentimiento de Conversions API.
Reiniciar la sesión de un número
PUT /api/v1/devices/{device}/reset · Sirve para reiniciar desde cero la sesión de WhatsApp de un número; después hay que volver a escanear el código QR. Es irreversible y requiere accounts:operate.
Configurar el webhook de mensajes recibidos
PUT /api/v1/devices/{device}/update-webhook-received · Sirve para configurar en un número el aviso de mensajes recibidos que usa Funnelchat para recibirlos.
Configurar el webhook de recibidos y entregas
PUT /api/v1/devices/{device}/update-webhook-received-and-delivery · Sirve para configurar en un número los avisos de mensajes recibidos y de confirmaciones de entrega que usa Funnelchat.
Limpiar un número
POST /api/v1/devices/{device}/clean · Sirve para limpiar la sesión de WhatsApp de un número: después hay que volver a escanear el código QR. Es irreversible y requiere accounts:operate.
Listar los chats de un número
GET /api/v1/devices/{device}/chats · Usalo para listar los chats que tiene un número en WhatsApp según el proveedor, con búsqueda por teléfono y filtro por tipo.
Ver qué teléfonos tienen conversación abierta
GET /api/v1/devices/{device}/open-conversations · Sirve para chequear en lote, hasta 100 teléfonos por llamada, cuáles tienen una conversación abierta con un número, por ejemplo antes de decidir cómo contactarlos.
Ver la cola de mensajes
GET /api/v1/devices/{device}/message-queue · Usalo para ver los mensajes que esperan en la cola de un número, por ejemplo para entender por qué algo todavía no salió.
Eliminar mensajes de la cola
DELETE /api/v1/devices/{device}/message-queue · Sirve para sacar de la cola mensajes puntuales, por su UID, antes de que se envíen, por ejemplo uno que se encoló por error.
Contar los mensajes en la cola
GET /api/v1/devices/{device}/message-queue/count · Usalo para monitorear cuántos mensajes tiene encolados un número, por ejemplo para detectar atascos.
Vaciar la cola de mensajes
DELETE /api/v1/devices/{device}/message-queue/all · Sirve para vaciar toda la cola de un número cuando hay que frenar envíos acumulados. Descarta los mensajes sin dejar registro; es irreversible y requiere accounts:operate.
Ver el estado de conexión
GET /api/v1/devices/{device}/status · Usalo para chequear el estado de conexión de un número, por ejemplo antes de lanzar envíos o para monitorear tus números.
Pedir un token para la extensión de WhatsApp Web
POST /api/v1/devices/{device}/extension-token · Sirve para obtener un código de un solo uso y corta duración con el que la extensión de Chrome Z-API Conector transfiere una sesión de WhatsApp Web a este número. Solo para números Z-API.
Listar entradas y salidas de un grupo GET
Sirve para ver quién entró y salió de un grupo puntual y cuándo, con país y filtros por fecha o tipo de evento.
Listar números GET
Sirve para listar tus números de WhatsApp con su proveedor, si están conectados y activos y su estado de salud, y obtener los IDs que usan las demás operaciones.