Referencia de la API Sellia directo a WhatsApp Cloud
Esta API es un puente a WhatsApp Cloud, centralizando el envío de mensajes, gestión de plantillas y webhooks para desarrolladores.
Objetivo Principal
El objetivo de esta API es actuar como un puente directo y especializado para la API de WhatsApp Cloud de Meta. Su propósito es proveer a los desarrolladores una interfaz programática completa para interactuar exclusivamente con la plataforma de WhatsApp Business. Centraliza todas las operaciones necesarias para una comunicación empresarial robusta a través de este canal: envío de todo tipo de mensajes (texto, multimedia, interactivos), creación y gestión de plantillas, y la configuración de webhooks para recibir eventos en tiempo real.
Utilidad Práctica
La utilidad de esta guía es para desarrolladores que necesitan integrar funcionalidades de WhatsApp Business directamente en sus aplicaciones o sistemas. Es ideal para:
Automatizar notificaciones
Enviar confirmaciones de compra, recordatorios de citas o actualizaciones de envío.
Construir chatbots y flujos conversacionales
Crear experiencias de cliente interactivas utilizando botones y listas.
Gestionar campañas de marketing
Administrar y enviar mensajes basados en plantillas aprobadas por Meta.
Sincronizar conversaciones
Recibir mensajes entrantes y actualizaciones de estado (entregado, leído) para mantener los sistemas internos actualizados.
Tokens de acceso
La API admite tokens de acceso de usuario del sistema. Puedes obtener un token de acceso de usuario mediante una solicitud de inicio de sesión del usuario del sistema. Esta solicitud recuperará un token válido para la autenticación. Dado que los tokens de acceso de usuario caducan a las 24 horas, asegúrate de actualizarla según corresponda. Una vez que tengas tu token, guárdalo como valor actual en el entorno.
Paginación
Los endpoints que devuelven listas/colecciones pueden paginar los resultados (verás las propiedades anterior y siguiente en la respuesta). Usa las URL de estas propiedades para obtener el conjunto de resultados anterior o siguiente. Tenga en cuenta que si hace clic en uno de estos enlaces en Postman, se abrirá una nueva consulta en una nueva pestaña que debe guardar antes de ejecutar (de lo contrario, no podrá leer las variables de entorno), por lo que es posible que desee cortar y pegar la URL y ejecutar la consulta en la misma pestaña en la que se devolvió.
Secciones
Esta sección gestiona la obtención de credenciales para la API. Para acceder a los endpoints protegidos, es necesario realizar una petición POST a /api/v1/login/manager con el nombre de usuario y la contraseña. La respuesta devuelve un Bearer Token con una validez de 24 horas, el cual debe ser incluido en el encabezado Authorization de las solicitudes subsecuentes.
Agrupa los endpoints para el envío y la gestión de mensajes. El endpoint principal permite enviar distintos tipos de mensajes (texto, media, interactivos, plantillas) a través de una petición POST, estructurando el contenido en el payload correspondiente. Incluye también operaciones para la subida de archivos multimedia, que devuelve un ID para su uso posterior en mensajes, y para la recuperación de media existente a través de su ID.
Contiene los endpoints para la administración de plantillas de mensajes. Estas plantillas, que deben ser pre aprobadas por Meta, son indispensables para iniciar conversaciones con los usuarios (business-initiated conversations). La API permite crear nuevas plantillas con componentes dinámicos (variables, media, botones) y consultar las plantillas existentes asociadas a la cuenta.
Agrupa los endpoints administrativos para la configuración del canal. Sus funciones principales son el registro de un nuevo canal, asociando una Cuenta de WhatsApp Business (WABA) y un número de teléfono, y la gestión de la URL del webhook. Permite establecer y consultar el endpoint de la aplicación que recibirá las notificaciones entrantes de la API.
Define la interfaz para la recepción de eventos asíncronos desde la plataforma de WhatsApp. El endpoint del webhook recibe notificaciones (callbacks) mediante peticiones POST. Los payloads de estas notificaciones informan sobre eventos críticos como la recepción de mensajes, cambios en el estado de los mensajes enviados (sent, delivered, read), y las interacciones del usuario con componentes interactivos.
Esta sección documenta los esquemas de datos (schemas) utilizados en toda la API. Define la estructura formal de los objetos JSON para los cuerpos de solicitud (request bodies) y las respuestas (responses). Cada modelo especifica las propiedades, sus tipos de datos, formatos y si son obligatorios, sirviendo como el contrato de datos para la serialización y deserialización de la información intercambiada con los endpoints.
La documentación de API es una solución integral para desarrolladores que centraliza y simplifica la integración con WhatsApp Cloud, proveyendo todas las herramientas para construir sistemas de comunicación empresarial robustos, interactivos y automatizados.
Last updated